blob: b8acfb5eb1585d06a576e6b524728f2ecc534a7f [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)
47# * OPENSSL_NEXT = 1.1.1a
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.
Gilles Peskine878cf602019-01-06 20:50:38 +000077# * support_XXX: if support_XXX exists and returns false then
78# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010079# * post_XXX: things to do after running the tests.
80# * other: miscellaneous support functions.
81#
Gilles Peskinec70637a2019-01-09 22:29:17 +010082# Each component must start by invoking `msg` with a short informative message.
83#
Gilles Peskinea681c592020-03-28 21:27:40 +010084# Warning: due to the way bash detects errors, the failure of a command
85# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
86#
Gilles Peskinece266c42020-03-28 18:50:43 +010087# Each component is executed in a separate shell process. The component
88# fails if any command in it returns a non-zero status.
89#
Gilles Peskinec70637a2019-01-09 22:29:17 +010090# The framework performs some cleanup tasks after each component. This
91# means that components can assume that the working directory is in a
92# cleaned-up state, and don't need to perform the cleanup themselves.
93# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010094# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010095# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010096# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
97# `tests/Makefile` and `programs/fuzz/Makefile` from git.
98# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +010099#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100100# The tests are roughly in order from fastest to slowest. This doesn't
101# have to be exact, but in general you should add slower tests towards
102# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100103
104
105
106################################################################
107#### Initialization and command line parsing
108################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100109
Gilles Peskine36647802020-03-28 18:50:49 +0100110# Abort on errors (even on the left-hand side of a pipe).
111# Treat uninitialised variables as errors.
112set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100113
Gilles Peskine076f7252022-08-30 21:02:44 +0200114# Enable ksh/bash extended file matching patterns
115shopt -s extglob
116
David Horstmann76a77382023-08-17 17:32:26 +0100117in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100118 test -d include -a -d library -a -d programs -a -d tests
119}
120
Ronald Cron070e8652023-10-09 10:25:45 +0200121in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100122 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100123}
124
Gilles Peskine8f073122018-11-27 15:58:47 +0100125pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200126 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
127 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100128 exit 1
129 fi
130}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100131
Gilles Peskine8f073122018-11-27 15:58:47 +0100132pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100133 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100134 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100135 else
136 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100137 fi
John Durkopbd069d32020-10-31 22:14:03 -0700138 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100139 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200140
141 # Files that are clobbered by some jobs will be backed up. Use a different
142 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
143 # independently decide when to remove the backup file.
144 backup_suffix='.all.bak'
145 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100146 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100147 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100148 # Files clobbered by in-tree cmake
149 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
150 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200151
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200152 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100153 MEMORY=0
154 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200155 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100156 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100157
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200158 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200159 #
160 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
161 # both values are kept in sync. If you change the value here because it
162 # breaks some tests, you'll definitely want to change it in
163 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200164 RELEASE_SEED=1
165
Yanray Wang18040ed2023-11-23 21:29:56 +0800166 # Specify character collation for regular expressions and sorting with C locale
167 export LC_COLLATE=C
168
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200169 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200170 : ${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 +0200171 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200172 export MBEDTLS_TEST_PLATFORM
173
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000174 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100175 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL_NEXT:="$OPENSSL"}
177 : ${GNUTLS_CLI:="gnutls-cli"}
178 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100179 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
180 : ${ARMC5_BIN_DIR:=/usr/bin}
181 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200182 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200183 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100184 : ${CLANG_LATEST:="clang-latest"}
185 : ${CLANG_EARLIEST:="clang-earliest"}
186 : ${GCC_LATEST:="gcc-latest"}
187 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100188 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000189 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200190 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100191 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000192
Gilles Peskine396853a2021-09-20 18:57:55 +0200193 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000194 export CTEST_OUTPUT_ON_FAILURE=1
195
Gilles Peskine8fd59422019-10-21 17:11:33 +0200196 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100197 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200198 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Gilles Peskine8fd59422019-10-21 17:11:33 +0200199
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400200 # Platform tests have an allocation that returns null
201 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400202 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400203
Gilles Peskine878cf602019-01-06 20:50:38 +0000204 # Gather the list of available components. These are the functions
205 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100206 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000207
208 # Exclude components that are not supported on this platform.
209 SUPPORTED_COMPONENTS=
210 for component in $ALL_COMPONENTS; do
211 case $(type "support_$component" 2>&1) in
212 *' function'*)
213 if ! support_$component; then continue; fi;;
214 esac
215 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
216 done
Gilles Peskine8f073122018-11-27 15:58:47 +0100217}
Andres AG38495a32016-07-12 16:54:33 +0100218
Gilles Peskinea28db922019-01-10 00:05:18 +0100219# Test whether the component $1 is included in the command line patterns.
220is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100221{
Gilles Peskine03af6782021-08-06 11:35:17 +0200222 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
223 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100224 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000225 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100226 set +f
227 case ${1#component_} in $pattern) return 0;; esac
228 done
229 set +f
230 return 1
231}
Andres AG7770ea82016-10-10 15:46:20 +0100232
Simon Butcher41eeccf2016-09-07 00:07:09 +0100233usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100234{
Gilles Peskine709346a2017-12-10 23:43:39 +0100235 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100236Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100237Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100238By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100239COMPONENT can be the name of a component or a shell wildcard pattern.
240
241Examples:
242 $0 "check_*"
243 Run all sanity checks.
244 $0 --no-armcc --except test_memsan
245 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100246
247Special options:
248 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000249 --list-all-components List all available test components and exit.
250 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100251
252General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200253 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100254 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100255 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100256 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200257 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200258 --arm-none-eabi-gcc-prefix=<string>
259 Prefix for a cross-compiler for arm-none-eabi
260 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200261 --arm-linux-gnueabi-gcc-prefix=<string>
262 Prefix for a cross-compiler for arm-linux-gnueabi
263 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100264 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200265 --restore First clean up the build tree, restoring backed up
266 files. Do not run any components unless they are
267 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100268 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200269 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100270 --except Exclude the COMPONENTs listed on the command line,
271 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200272 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100273 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100274 --no-force Refuse to overwrite modified files (default).
275 --no-keep-going Stop at the first error (default).
276 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800277 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100278 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200279 --outcome-file=<path> File where test outcomes are written (not done if
280 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100281 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200282 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100283 -s|--seed Integer seed value to use for this test run.
284
285Tool path options:
286 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
287 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100288 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
289 --clang-latest=<Clang_latest_path> Latest version of clang available
290 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
291 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100292 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
293 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100294 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100295 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100296EOF
SimonB2e23c822016-04-16 21:54:39 +0100297}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100298
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200299# Cleanup before/after running a component.
300# Remove built files as well as the cmake cache/config.
301# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100302cleanup()
303{
David Horstmann76a77382023-08-17 17:32:26 +0100304 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100305 command make clean
306 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200307
Gilles Peskine31b07e22018-03-21 12:15:06 +0100308 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000309 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100310 -iname CMakeFiles -exec rm -rf {} \+ -o \
311 \( -iname cmake_install.cmake -o \
312 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200313 -iname CMakeCache.txt -o \
314 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100315 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200316 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200317
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100318 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
319 rm -rf programs/test/cmake_subproject/build
320 rm -f programs/test/cmake_subproject/Makefile
321 rm -f programs/test/cmake_subproject/cmake_subproject
322
Chris Kayd259e342021-03-25 16:03:25 +0000323 # Remove any artifacts from the component_test_cmake_as_package test.
324 rm -rf programs/test/cmake_package/build
325 rm -f programs/test/cmake_package/Makefile
326 rm -f programs/test/cmake_package/cmake_package
327
328 # Remove any artifacts from the component_test_cmake_as_installed_package test.
329 rm -rf programs/test/cmake_package_install/build
330 rm -f programs/test/cmake_package_install/Makefile
331 rm -f programs/test/cmake_package_install/cmake_package_install
332
Gilles Peskinef83eb822020-03-30 20:11:39 +0200333 # Restore files that may have been clobbered by the job
334 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200335 if [[ -e "$x$backup_suffix" ]]; then
336 cp -p "$x$backup_suffix" "$x"
337 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200338 done
339}
John Durkopbd069d32020-10-31 22:14:03 -0700340
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200341# Final cleanup when this script exits (except when exiting on a failure
342# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200343final_cleanup () {
344 cleanup
345
346 for x in $files_to_back_up; do
347 rm -f "$x$backup_suffix"
348 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100349}
350
Gilles Peskine7c652162017-12-11 00:01:40 +0100351# Executed on exit. May be redefined depending on command line options.
352final_report () {
353 :
354}
355
356fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200357 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100358 final_report $1
359 trap - $1
360 kill -$1 $$
361}
362
363trap 'fatal_signal HUP' HUP
364trap 'fatal_signal INT' INT
365trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200366
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200367# Number of processors on this machine. Used as the default setting
368# for parallel make.
369all_sh_nproc ()
370{
371 {
372 nproc || # Linux
373 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
374 sysctl -n hw.ncpu || # FreeBSD
375 echo 1
376 } 2>/dev/null
377}
378
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100379msg()
380{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100381 if [ -n "${current_component:-}" ]; then
382 current_section="${current_component#component_}: $1"
383 else
384 current_section="$1"
385 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200386
387 if [ $QUIET -eq 1 ]; then
388 return
389 fi
390
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100391 echo ""
392 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100393 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000394 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100395 echo "******************************************************************"
396}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100397
Gilles Peskine8f073122018-11-27 15:58:47 +0100398armc6_build_test()
399{
400 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100401
Gilles Peskine18487f62020-04-30 23:11:54 +0200402 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800403 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100404 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000405 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200406
407 msg "size: ARM Compiler 6 ($FLAGS)"
408 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100409}
Andres AGa5cd9732016-10-17 15:23:10 +0100410
Andres AGd9eba4b2016-08-26 14:42:14 +0100411err_msg()
412{
413 echo "$1" >&2
414}
415
416check_tools()
417{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200418 for tool in "$@"; do
419 if ! `type "$tool" >/dev/null 2>&1`; then
420 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100421 exit 1
422 fi
423 done
424}
425
Tom Cosgrove730addc2023-06-09 14:20:18 +0100426pre_parse_command_line_for_dirs () {
427 # Make an early pass through the options given, so we can set directories
428 # for Arm compilers, before SUPPORTED_COMPONENTS is determined.
429 while [ $# -gt 0 ]; do
430 case "$1" in
431 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
432 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
433 esac
434 shift
435 done
436}
437
Gilles Peskine8f073122018-11-27 15:58:47 +0100438pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000439 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100440 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100441 error_test=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200442 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000443 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100444
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000445 # Note that legacy options are ignored instead of being omitted from this
446 # list of options, so invocations that worked with previous version of
447 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100448 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100449 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200450 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200451 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200452 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000453 --armcc) no_armcc=;;
Tom Cosgrove730addc2023-06-09 14:20:18 +0100454 --armc5-bin-dir) shift; ;; # assignment to ARMC5_BIN_DIR done in pre_parse_command_line_for_dirs
455 --armc6-bin-dir) shift; ;; # assignment to ARMC6_BIN_DIR done in pre_parse_command_line_for_dirs
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100456 --clang-earliest) shift; CLANG_EARLIEST="$1";;
457 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100458 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000459 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100460 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100461 --gcc-earliest) shift; GCC_EARLIEST="$1";;
462 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100463 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200464 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
465 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100466 --gnutls-serv) shift; GNUTLS_SERV="$1";;
467 --help|-h) usage; exit;;
468 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000469 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
470 --list-components) printf '%s\n' $SUPPORTED_COMPONENTS; exit;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100471 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200472 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000473 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100474 --no-force) FORCE=0;;
475 --no-keep-going) KEEP_GOING=0;;
476 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200477 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100479 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200480 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200482 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200484 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200485 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --seed|-s) shift; SEED="$1";;
487 -*)
488 echo >&2 "Unknown option: $1"
489 echo >&2 "Run $0 --help for usage."
490 exit 120
491 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000492 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 esac
494 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100495 done
SimonB2e23c822016-04-16 21:54:39 +0100496
Gilles Peskinea28db922019-01-10 00:05:18 +0100497 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200498 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000499 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100500 fi
501
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000502 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
503 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100504 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000505 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100506 fi
SimonB2e23c822016-04-16 21:54:39 +0100507
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200508 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100509 if [ $all_except -eq 0 ]; then
510 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200511 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
512 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200513 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100514 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200515 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200516 # If the requested name includes a wildcard character, don't
517 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100518 case $component in
519 *[*?\[]*) continue;;
520 esac
521 case " $SUPPORTED_COMPONENTS " in
522 *" $component "*) :;;
523 *)
524 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
525 unsupported=$((unsupported + 1));;
526 esac
527 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200528 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100529 if [ $unsupported -ne 0 ]; then
530 exit 2
531 fi
532 fi
533
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000534 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100535 RUN_COMPONENTS=
536 for component in $SUPPORTED_COMPONENTS; do
537 if is_component_included "$component"; [ $? -eq $all_except ]; then
538 RUN_COMPONENTS="$RUN_COMPONENTS $component"
539 fi
540 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000541
542 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000543 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100544}
SimonB2e23c822016-04-16 21:54:39 +0100545
Gilles Peskine8f073122018-11-27 15:58:47 +0100546pre_check_git () {
547 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100548 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100549 git checkout-index -f -q $CONFIG_H
550 cleanup
551 else
SimonB2e23c822016-04-16 21:54:39 +0100552
Gilles Peskine8f073122018-11-27 15:58:47 +0100553 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
554 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
555 echo "You can either delete this directory manually, or force the test by rerunning"
556 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
557 exit 1
558 fi
559
Ronald Cron7a93ac52023-07-20 09:49:12 +0200560 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100561 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100562 echo "You can either delete or preserve your work, or force the test by rerunning the"
563 echo "script as: $0 --force"
564 exit 1
565 fi
SimonB2e23c822016-04-16 21:54:39 +0100566 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500567}
568
Gilles Peskine568f53a2021-07-12 18:16:01 +0200569pre_restore_files () {
570 # If the makefiles have been generated by a framework such as cmake,
571 # restore them from git. If the makefiles look like modifications from
572 # the ones checked into git, take care not to modify them. Whatever
573 # this function leaves behind is what the script will restore before
574 # each component.
575 case "$(head -n1 Makefile)" in
576 *[Gg]enerated*)
577 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
578 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
579 ;;
580 esac
581}
582
Gilles Peskinef83eb822020-03-30 20:11:39 +0200583pre_back_up () {
584 for x in $files_to_back_up; do
585 cp -p "$x" "$x$backup_suffix"
586 done
587}
588
Gilles Peskine8f073122018-11-27 15:58:47 +0100589pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100590 failure_count=0 # Number of failed components
591 last_failure_status=0 # Last failure status in this component
592
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100593 # See err_trap
594 previous_failure_status=0
595 previous_failed_command=
596 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100597 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100598
Gilles Peskine7c652162017-12-11 00:01:40 +0100599 start_red=
600 end_color=
601 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100602 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100603 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
604 start_red=$(printf '\033[31m')
605 end_color=$(printf '\033[0m')
606 ;;
607 esac
608 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100609
610 # Keep a summary of failures in a file. We'll print it out at the end.
611 failure_summary_file=$PWD/all-sh-failures-$$.log
612 : >"$failure_summary_file"
613
614 # Whether it makes sense to keep a component going after the specified
615 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200616 # This function normally receives the failing simple command
617 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
618 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100619 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200620 # False positives result in running things that can't be expected to
621 # work. False negatives result in things not running after something else
622 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100623 can_keep_going_after_failure () {
624 case "$1" in
625 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200626 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100627 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200628 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
629 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
630 *make*check*) true;;
631 "grep "*) true;;
632 "[ "*) true;;
633 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100634 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100635 esac
636 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100637
638 # This function runs if there is any error in a component.
639 # It must either exit with a nonzero status, or set
640 # last_failure_status to a nonzero value.
641 err_trap () {
642 # Save $? (status of the failing command). This must be the very
643 # first thing, before $? is overridden.
644 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100645 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100646
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100647 if [[ $last_failure_status -eq $previous_failure_status &&
648 "$failed_command" == "$previous_failed_command" &&
649 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
650 then
651 # The same command failed twice in a row, but this time one level
652 # less deep in the function call stack. This happens when the last
653 # command of a function returns a nonzero status, and the function
654 # returns that same status. Ignore the second failure.
655 previous_failure_funcall_depth=${#FUNCNAME[@]}
656 return
657 fi
658 previous_failure_status=$last_failure_status
659 previous_failed_command=$failed_command
660 previous_failure_funcall_depth=${#FUNCNAME[@]}
661
Gilles Peskinece266c42020-03-28 18:50:43 +0100662 text="$current_section: $failed_command -> $last_failure_status"
663 echo "${start_red}^^^^$text^^^^${end_color}" >&2
664 echo "$text" >>"$failure_summary_file"
665
666 # If the command is fatal (configure or build command), stop this
667 # component. Otherwise (test command) keep the component running
668 # (run more tests from the same build).
669 if ! can_keep_going_after_failure "$failed_command"; then
670 exit $last_failure_status
671 fi
672 }
673
Gilles Peskine7c652162017-12-11 00:01:40 +0100674 final_report () {
675 if [ $failure_count -gt 0 ]; then
676 echo
677 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100678 echo "${start_red}FAILED: $failure_count components${end_color}"
679 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100680 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
681 elif [ -z "${1-}" ]; then
682 echo "SUCCESS :)"
683 fi
684 if [ -n "${1-}" ]; then
685 echo "Killed by SIG$1."
686 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100687 rm -f "$failure_summary_file"
688 if [ $failure_count -gt 0 ]; then
689 exit 1
690 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100691 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100692}
693
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200694# record_status() and if_build_succeeded() are kept temporarily for backward
695# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100696record_status () {
697 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100698}
Gilles Peskine7c652162017-12-11 00:01:40 +0100699if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100700 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100701}
702
Gilles Peskinea681c592020-03-28 21:27:40 +0100703# '! true' does not trigger the ERR trap. Arrange to trigger it, with
704# a reasonably informative error message (not just "$@").
705not () {
706 if "$@"; then
707 report_failed_command="! $*"
708 false
709 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200710 fi
711}
712
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200713pre_prepare_outcome_file () {
714 case "$MBEDTLS_TEST_OUTCOME_FILE" in
715 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
716 esac
717 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
718 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
719 fi
720}
721
Gilles Peskine8f073122018-11-27 15:58:47 +0100722pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200723 if [ $QUIET -eq 1 ]; then
724 return
725 fi
726
Gilles Peskine8f073122018-11-27 15:58:47 +0100727 msg "info: $0 configuration"
728 echo "MEMORY: $MEMORY"
729 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200730 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100731 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100732 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100733 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100734 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
735 echo "GNUTLS_CLI: $GNUTLS_CLI"
736 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100737 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
738 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
739}
Andres AG7770ea82016-10-10 15:46:20 +0100740
Andres AGd9eba4b2016-08-26 14:42:14 +0100741# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100742pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000743 # Build the list of variables to pass to output_env.sh.
744 set env
SimonB2e23c822016-04-16 21:54:39 +0100745
Gilles Peskine87964262019-01-06 22:40:00 +0000746 case " $RUN_COMPONENTS " in
747 # Require OpenSSL and GnuTLS if running any tests (as opposed to
748 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
749 # is a good enough approximation in practice.
750 *" test_"*)
751 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
752 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100753 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000754 export GNUTLS_CLI="$GNUTLS_CLI"
755 export GNUTLS_SERV="$GNUTLS_SERV"
756 # Avoid passing --seed flag in every call to ssl-opt.sh
757 if [ -n "${SEED-}" ]; then
758 export SEED
759 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200760 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000761 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200762 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
763 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000764 ;;
765 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200766
Gilles Peskine87964262019-01-06 22:40:00 +0000767 case " $RUN_COMPONENTS " in
768 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
769 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100770
Gilles Peskine87964262019-01-06 22:40:00 +0000771 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200772 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000773 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100774
Gilles Peskine87964262019-01-06 22:40:00 +0000775 case " $RUN_COMPONENTS " in
776 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
777 esac
778
779 case " $RUN_COMPONENTS " in
780 *" test_zeroize "*) check_tools "gdb";;
781 esac
782
783 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000784 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000785 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
786 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200787 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000788 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
789 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200790 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
791 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
792 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000793 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000794
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200795 # past this point, no call to check_tool, only printing output
796 if [ $QUIET -eq 1 ]; then
797 return
798 fi
799
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000800 msg "info: output_env.sh"
801 case $RUN_COMPONENTS in
802 *_armcc*)
803 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
804 *) set "$@" RUN_ARMCC=0;;
805 esac
806 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100807}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100808
Gilles Peskine1570b592021-04-22 01:10:12 +0200809pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200810 # since make doesn't have proper dependencies, remove any possibly outdate
811 # file that might be around before generating fresh ones
812 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200813 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200814 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200815 else
816 make generated_files
817 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200818}
819
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200820################################################################
821#### Helpers for components using libtestdriver1
822################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100823
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200824# How to use libtestdriver1
825# -------------------------
826#
827# 1. Define the list algorithms and key types to accelerate,
828# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
829# Examples:
830# - loc_accel_list="ALG_JPAKE"
831# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200832# 2. Make configurations changes for the driver and/or main libraries.
833# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
834# can be either "default" to start with the default config, or a name
835# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200836# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200837# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
838# These changes affect both the driver and the main libraries.
839# (Note: they need to have the same set of PSA_WANT symbols, as that
840# determines the ABI between them.)
841# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
842# main libraries. Typically, you want to disable the module(s) that are
843# being accelerated. You may need to also disable modules that depend
844# on them or options that are not supported with drivers.
845# 2d. On top of psa/crypto_config.h, the driver library uses its own config
846# file: tests/include/test/drivers/config_test_driver.h. You usually
847# don't need to edit it: using loc_extra_list (see below) is preferred.
848# However, when there's no PSA symbol for what you want to enable,
849# calling scripts/config.py on this file remains the only option.
850# 3. Build the driver library, then the main libraries, test, and programs.
851# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
852# need to enable more algorithms here, typically hash algorithms when
853# accelerating some signature algorithms (ECDSA, RSAv2). This is done
854# by passing a 2nd argument listing the extra algorithms.
855# Example:
856# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
857# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800858# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200859# additional arguments will be passed to make: this can be useful if
860# you don't want to build everything when iterating during development.
861# Example:
862# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
863# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200864
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200865# Adjust the configuration - for both libtestdriver1 and main library,
866# as they should have the same PSA_WANT macros.
867helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200868 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200869 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200870 if [ "$base_config" != "default" ]; then
871 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200872 fi
873
874 # Enable PSA-based config (necessary to use drivers)
875 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
876
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200877 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
878 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
879 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200880}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100881
Valerio Settib2fd6732023-08-15 17:10:47 +0200882# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200883# The function optionally accepts 1 parameter: a space-separated list of the
884# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200885helper_disable_builtin_curves() {
886 allowed_list="${1:-}"
887 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
888
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200889 for curve in $allowed_list; do
890 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200891 done
892}
893
894# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
895# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
896# in the following helpers.
897helper_get_psa_curve_list () {
898 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200899 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
900 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200901 done
902
903 echo "$loc_list"
904}
905
906# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200907# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200908# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200909helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200910 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200911 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200912 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 +0200913 # Skip DERIVE for elliptic keys since there is no driver dispatch for
914 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200915 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
916 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200917 fi
918 done
919
920 echo "$loc_list"
921}
922
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200923# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200924#
925# Parameters:
926# 1. a space-separated list of things to accelerate;
927# 2. optional: a space-separate list of things to also support.
928# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
929helper_libtestdriver1_make_drivers() {
930 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
931 make -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
932}
933
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200934# Build the main libraries, programs and tests,
935# linking to the drivers library (with ASan).
936#
937# Parameters:
938# 1. a space-separated list of things to accelerate;
939# *. remaining arguments if any are passed directly to make
940# (examples: lib, -C tests test_suite_xxx, etc.)
941# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
942helper_libtestdriver1_make_main() {
943 loc_accel_list=$1
944 shift
945
946 # we need flags both with and without the LIBTESTDRIVER1_ prefix
947 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
948 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
949 make CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
950}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100951
952################################################################
953#### Basic checks
954################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100955
956#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200957# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100958#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +0100959# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200960# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100961# 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 +0200962# time, so start with a GCC build).
963# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100964#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +0100965# Indicative running times are given for reference.
966
Gilles Peskine8f073122018-11-27 15:58:47 +0100967component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200968 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200969 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +0100970}
Janos Follathb72c6782016-07-19 14:54:17 +0100971
Gilles Peskine67debb62021-05-18 16:09:50 +0200972component_check_generated_files () {
973 msg "Check: check-generated-files, files generated with make" # 2s
974 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200975 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +0200976
977 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200978 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +0200979 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200980 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +0200981
982 msg "Check: check-generated-files -u, files absent" # 2s
983 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200984 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +0200985 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200986 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +0200987
988 # This component ends with the generated files present in the source tree.
989 # This is necessary for subsequent components!
990}
991
Gilles Peskine8f073122018-11-27 15:58:47 +0100992component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200993 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200994 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +0100995}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200996
Gilles Peskine8f073122018-11-27 15:58:47 +0100997component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200998 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200999 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001000}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001001
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001002component_check_changelog () {
1003 msg "Check: changelog entries" # < 1s
1004 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001005 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001006 if [ -e ChangeLog.new ]; then
1007 # Show the diff for information. It isn't an error if the diff is
1008 # non-empty.
1009 diff -u ChangeLog ChangeLog.new || true
1010 rm ChangeLog.new
1011 fi
1012}
1013
Gilles Peskine8f073122018-11-27 15:58:47 +01001014component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001015 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001016 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001017}
Darryl Greena07039c2018-03-13 16:48:16 +00001018
Gilles Peskine895868b2019-09-19 21:30:05 +02001019component_check_test_cases () {
1020 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001021 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001022 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001023 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001024 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001025 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001026 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001027 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001028}
1029
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001030component_check_test_dependencies () {
1031 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001032 # The purpose of this component is to catch unjustified dependencies on
1033 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1034 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1035 # MBEDTLS_PSA_xxx).
1036 #
1037 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1038 # this component is meant to catch. However a few of them are justified,
1039 # mostly by the absence of a PSA equivalent, so this component includes a
1040 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001041
1042 found="check-test-deps-found-$$"
1043 expected="check-test-deps-expected-$$"
1044
1045 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001046 grep 'depends_on' \
1047 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001048 grep -Eo '!?MBEDTLS_[^: ]*' |
1049 grep -v MBEDTLS_PSA_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001050 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001051
Yanray Wang18040ed2023-11-23 21:29:56 +08001052 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001053 rm -f $expected
1054 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1055 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001056 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1057 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001058 # This is used by import_rsa_made_up() in test_suite_psa_crypto in order
1059 # to build a fake RSA key of the wanted size based on
1060 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1061 # the test code and that's probably the most convenient way of achieving
1062 # the test's goal.
1063 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1064 # No PSA equivalent - we should probably have one in the future.
1065 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1066 # No PSA equivalent - needed by some init tests
1067 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
1068 # Used by two tests that are about an extension to the PSA standard;
1069 # as such, no PSA equivalent.
1070 echo "MBEDTLS_PEM_PARSE_C" >> $expected
1071
1072 # Compare reality with expectation.
1073 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001074 #
1075 # The output should be empty. When it's not:
1076 # - Each '+' line is a macro that was found but not expected. You want to
1077 # find where that macro occurs, and either replace it with PSA macros, or
1078 # add it to the exceptions list above with a justification.
1079 # - Each '-' line is a macro that was expected but not found; it means the
1080 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001081 diff -U0 $expected $found
1082
1083 rm $found $expected
1084}
1085
Gilles Peskine8f073122018-11-27 15:58:47 +01001086component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001087 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001088 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001089}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001090
Gilles Peskine192c72f2017-12-21 15:59:21 +01001091
Gilles Peskine636c26a2020-03-04 20:46:15 +01001092
Gilles Peskine192c72f2017-12-21 15:59:21 +01001093################################################################
1094#### Build and test many configurations and targets
1095################################################################
1096
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001097component_test_default_out_of_box () {
1098 msg "build: make, default config (out-of-box)" # ~1min
1099 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001100 # Disable fancy stuff
1101 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001102
1103 msg "test: main suites make, default config (out-of-box)" # ~10s
1104 make test
1105
1106 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001107 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001108
1109 msg "program demos: make, default config (out-of-box)" # ~10s
1110 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001111}
1112
Gilles Peskine8f073122018-11-27 15:58:47 +01001113component_test_default_cmake_gcc_asan () {
1114 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001115 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1116 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001117
Gilles Peskine8f073122018-11-27 15:58:47 +01001118 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1119 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001120
Gilles Peskine82b27272019-06-14 18:27:03 +02001121 msg "program demos (ASan build)" # ~10s
1122 tests/scripts/run_demos.py
1123
Gilles Peskine97bea012020-04-23 23:37:45 +02001124 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001125 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001126
Gilles Peskine6848d172023-11-02 19:58:03 +01001127 msg "test: metatests (GCC, ASan build)"
1128 tests/scripts/run-metatests.sh any asan
1129
Gilles Peskine8f073122018-11-27 15:58:47 +01001130 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001131 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001132
Gilles Peskine8f073122018-11-27 15:58:47 +01001133 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001134 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001135
1136 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001137 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001138}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001139
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001140component_test_default_cmake_gcc_asan_new_bignum () {
1141 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001142 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001143 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001144 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001145
1146 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1147 make test
1148
1149 msg "test: selftest (ASan build)" # ~ 10s
1150 programs/test/selftest
1151
1152 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1153 tests/ssl-opt.sh
1154
1155 msg "test: compat.sh (ASan build)" # ~ 6 min
1156 tests/compat.sh
1157
1158 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1159 tests/context-info.sh
1160}
1161
Hanno Becker01635512019-02-26 14:27:09 +00001162component_test_full_cmake_gcc_asan () {
1163 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001164 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001165 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1166 make
1167
1168 msg "test: main suites (inc. selftests) (full config, ASan build)"
1169 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001170
Gilles Peskine97bea012020-04-23 23:37:45 +02001171 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001172 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001173
Gilles Peskine636c26a2020-03-04 20:46:15 +01001174 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001175 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001176
1177 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001178 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001179
1180 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001181 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001182}
1183
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001184
1185component_test_full_cmake_gcc_asan_new_bignum () {
1186 msg "build: full config, cmake, gcc, ASan"
1187 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001188 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001189 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001190 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001191
1192 msg "test: main suites (inc. selftests) (full config, ASan build)"
1193 make test
1194
1195 msg "test: selftest (ASan build)" # ~ 10s
1196 programs/test/selftest
1197
1198 msg "test: ssl-opt.sh (full config, ASan build)"
1199 tests/ssl-opt.sh
1200
1201 msg "test: compat.sh (full config, ASan build)"
1202 tests/compat.sh
1203
1204 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1205 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001206}
1207
Ronald Cronc3623db2020-10-29 10:51:32 +01001208component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001209 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001210 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001211 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1212 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1213 make
1214
1215 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1216 make test
1217}
1218
Gilles Peskinea3548672021-06-17 11:37:52 +02001219# check_renamed_symbols HEADER LIB
1220# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1221# name is LIB.
1222check_renamed_symbols () {
1223 ! nm "$2" | sed 's/.* //' |
1224 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1225}
1226
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001227component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001228 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001229 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001230 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1231 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1232 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1233 # We can only compile, not link, since our test and sample programs
1234 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1235 # is active.
1236 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001237
1238 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1239 # version is not present.
1240 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001241 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001242}
1243
Ronald Cron336678b2021-01-28 17:54:24 +01001244component_test_psa_crypto_client () {
1245 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1246 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1247 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1248 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001249 scripts/config.py unset MBEDTLS_LMS_C
1250 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Ronald Cron336678b2021-01-28 17:54:24 +01001251 make
1252
1253 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1254 make test
1255}
1256
Jaeden Amero424fa932021-05-14 08:34:32 +01001257component_test_psa_crypto_rsa_no_genprime() {
1258 msg "build: default config minus MBEDTLS_GENPRIME"
1259 scripts/config.py unset MBEDTLS_GENPRIME
1260 make
1261
1262 msg "test: default config minus MBEDTLS_GENPRIME"
1263 make test
1264}
1265
Gilles Peskine782f4112018-11-27 16:11:09 +01001266component_test_ref_configs () {
1267 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001268 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1269 # want to re-generate generated files that depend on it, quite correctly.
1270 # However this doesn't work as the generation script expects a specific
1271 # format for mbedtls_config.h, which the other files don't follow. Also,
1272 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001273 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001274 # whether they're on or off. So, disable cmake's (over-sensitive here)
1275 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001276 # present (thanks to pre_generate_files) by turning GEN_FILES off.
1277 CC=gcc cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001278 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001279}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001280
Gilles Peskine8f073122018-11-27 15:58:47 +01001281component_test_no_renegotiation () {
1282 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001283 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Gilles Peskine8f073122018-11-27 15:58:47 +01001284 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1285 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001286
Gilles Peskine8f073122018-11-27 15:58:47 +01001287 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1288 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001289
Gilles Peskine8f073122018-11-27 15:58:47 +01001290 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001291 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001292}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001293
Gilles Peskine636c26a2020-03-04 20:46:15 +01001294component_test_no_pem_no_fs () {
1295 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1296 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1297 scripts/config.py unset MBEDTLS_FS_IO
1298 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1299 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
1300 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1301 make
1302
1303 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1304 make test
1305
1306 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001307 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001308}
1309
Gilles Peskine8f073122018-11-27 15:58:47 +01001310component_test_rsa_no_crt () {
1311 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001312 scripts/config.py set MBEDTLS_RSA_NO_CRT
Gilles Peskine8f073122018-11-27 15:58:47 +01001313 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1314 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001315
Gilles Peskine8f073122018-11-27 15:58:47 +01001316 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1317 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001318
Gilles Peskine8f073122018-11-27 15:58:47 +01001319 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001320 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001321
Gilles Peskine8f073122018-11-27 15:58:47 +01001322 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001323 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001324
1325 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001326 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001327}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001328
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001329component_test_no_ctr_drbg_classic () {
1330 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001331 scripts/config.py full
1332 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001333 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001334 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001335
1336 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1337 make
1338
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001339 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001340 make test
1341
Gilles Peskineba749042021-01-13 20:02:03 +01001342 # In this configuration, the TLS test programs use HMAC_DRBG.
1343 # The SSL tests are slow, so run a small subset, just enough to get
1344 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001345 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001346 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001347
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001348 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001349 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001350}
1351
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001352component_test_no_ctr_drbg_use_psa () {
1353 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001354 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001355 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1356 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001357
1358 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1359 make
1360
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001361 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1362 make test
1363
1364 # In this configuration, the TLS test programs use HMAC_DRBG.
1365 # The SSL tests are slow, so run a small subset, just enough to get
1366 # confidence that the SSL code copes with HMAC_DRBG.
1367 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001368 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001369
1370 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001371 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001372}
1373
1374component_test_no_hmac_drbg_classic () {
1375 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1376 scripts/config.py full
1377 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1378 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1379 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001380 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001381
1382 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1383 make
1384
1385 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001386 make test
1387
Gilles Peskinea2224342020-11-19 22:14:34 +01001388 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1389 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1390 # instead.
1391 # Test SSL with non-deterministic ECDSA. Only test features that
1392 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001393 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001394 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001395
1396 # To save time, only test one protocol version, since this part of
1397 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001398 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001399 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001400}
1401
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001402component_test_no_hmac_drbg_use_psa () {
1403 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1404 scripts/config.py full
1405 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1406 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1407 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1408
1409 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1410 make
1411
1412 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1413 make test
1414
1415 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1416 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1417 # instead.
1418 # Test SSL with non-deterministic ECDSA. Only test features that
1419 # might be affected by how ECDSA signature is performed.
1420 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001421 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001422
1423 # To save time, only test one protocol version, since this part of
1424 # the protocol is identical in (D)TLS up to 1.2.
1425 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001426 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001427}
1428
1429component_test_psa_external_rng_no_drbg_classic () {
1430 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1431 scripts/config.py full
1432 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001433 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001434 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001435 scripts/config.py unset MBEDTLS_ENTROPY_C
1436 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1437 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001438 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1439 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1440 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001441 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1442 # the SSL test programs don't have an RNG and can't work. Explicitly
1443 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
1444 make CFLAGS="$ASAN_CFLAGS -O2 -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001445
1446 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1447 make test
1448
Gilles Peskine8eb29432021-02-03 20:07:11 +01001449 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001450 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001451}
1452
1453component_test_psa_external_rng_no_drbg_use_psa () {
1454 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001455 scripts/config.py full
1456 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001457 scripts/config.py unset MBEDTLS_ENTROPY_C
1458 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1459 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001460 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1461 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1462 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskinec109b372020-11-23 17:39:04 +01001463 make CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
1464
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001465 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001466 make test
1467
Gilles Peskine8eb29432021-02-03 20:07:11 +01001468 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001469 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001470}
1471
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001472component_test_psa_external_rng_use_psa_crypto () {
1473 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1474 scripts/config.py full
1475 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1476 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1477 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1478 make CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
1479
1480 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1481 make test
1482
1483 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1484 tests/ssl-opt.sh -f 'Default\|opaque'
1485}
1486
Gilles Peskine801c4332023-04-28 21:04:28 +02001487component_test_psa_inject_entropy () {
1488 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1489 scripts/config.py full
1490 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1491 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1492 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1493 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1494 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1495 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
1496 make CFLAGS="$ASAN_CFLAGS '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'" LDFLAGS="$ASAN_CFLAGS"
1497
1498 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1499 make test
1500}
1501
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001502component_test_sw_inet_pton () {
1503 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1504
1505 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1506 scripts/config.py set MBEDTLS_TEST_HOOKS
1507 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1508
1509 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1510 make test
1511}
1512
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001513component_test_crypto_full_md_light_only () {
1514 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001515 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001516 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001517 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001518 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001519 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001520 scripts/config.py unset MBEDTLS_HKDF_C
1521 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001522 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001523 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001524 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001525 # Disable things that would auto-enable MD_C
1526 scripts/config.py unset MBEDTLS_PKCS5_C
1527
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001528 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1529 # which we haven't disabled, so no need to explicitly enable it.
1530 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001531
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001532 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001533 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001534 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001535
1536 msg "test: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001537 make test
1538}
1539
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001540component_test_full_no_cipher () {
Valerio Settidf17a102023-10-23 14:14:19 +02001541 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001542 scripts/config.py full
1543 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001544 # Don't pull in cipher via PSA mechanisms
1545 # (currently ignored anyway because we completely disable PSA)
1546 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001547 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001548 scripts/config.py unset MBEDTLS_CMAC_C
1549 scripts/config.py unset MBEDTLS_NIST_KW_C
1550 scripts/config.py unset MBEDTLS_PKCS12_C
1551 scripts/config.py unset MBEDTLS_PKCS5_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001552 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1553 scripts/config.py unset MBEDTLS_SSL_TLS_C
1554 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001555 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001556 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1557 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001558 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001559 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001560 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001561
Valerio Settidf17a102023-10-23 14:14:19 +02001562 msg "test: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001563 make test
1564}
1565
Valerio Setti7e710e82023-08-25 09:14:15 +02001566# This is a common configurator and test function that is used in:
1567# - component_test_full_no_cipher_with_crypto
1568# - component_test_full_no_cipher_with_crypto_config
1569# It accepts 2 input parameters:
1570# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1571# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001572common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001573 USE_CRYPTO_CONFIG="$1"
1574 COMPONENT_DESCRIPTION="$2"
1575
1576 msg "build: $COMPONENT_DESCRIPTION"
1577
1578 scripts/config.py full
1579 scripts/config.py unset MBEDTLS_CIPHER_C
1580
1581 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001582 # The built-in implementation of the following algs/key-types depends
1583 # on CIPHER_C so we disable them.
1584 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1585 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001586 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001587 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1588 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1589 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1590 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1591 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1592 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1593 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1594 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001595 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001596 else
1597 # Don't pull in cipher via PSA mechanisms
1598 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001599 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1600 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1601 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti287f6d12023-10-24 14:12:59 +02001602 scripts/config.py unset MBEDTLS_DES_C
Valerio Setti287f6d12023-10-24 14:12:59 +02001603 # Dependencies on AES_C
1604 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001605 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001606 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001607 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001608 scripts/config.py unset MBEDTLS_NIST_KW_C
1609 scripts/config.py unset MBEDTLS_PKCS12_C
1610 scripts/config.py unset MBEDTLS_PKCS5_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001611
Gilles Peskine636c26a2020-03-04 20:46:15 +01001612 make
1613
Valerio Setti7e710e82023-08-25 09:14:15 +02001614 # Ensure that CIPHER_C was not re-enabled
1615 not grep mbedtls_cipher_init library/cipher.o
1616
1617 msg "test: $COMPONENT_DESCRIPTION"
1618 make test
1619}
1620
1621component_test_full_no_cipher_with_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001622 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001623}
1624
1625component_test_full_no_cipher_with_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001626 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001627}
1628
Valerio Settibdfecb62023-11-07 15:37:20 +01001629component_test_full_no_ccm() {
1630 msg "build: full no PSA_WANT_ALG_CCM"
1631
1632 # Full config enables:
1633 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1634 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1635 scripts/config.py full
1636
1637 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1638 # enabled, but not used from TLS since USE_PSA is set.
1639 # This is helpful to ensure that TLS tests below have proper dependencies.
1640 #
1641 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1642 # PSA_WANT_ALG_CCM to be re-enabled.
1643 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1644
Valerio Settiff2b06a2023-11-08 12:35:36 +01001645 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001646
1647 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001648 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001649}
1650
1651component_test_full_no_ccm_star_no_tag() {
1652 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1653
1654 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1655 scripts/config.py full
1656
1657 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1658 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1659 # This basically disables all unauthenticated ciphers on the PSA side, while
1660 # keeping AEADs enabled.
1661 #
1662 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1663 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1664 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1665 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1666 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1667 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1668 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1669 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1670 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1671 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1672
Valerio Settiff2b06a2023-11-08 12:35:36 +01001673 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001674
1675 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001676 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001677
1678 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001679 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001680}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001681
Valerio Settie1655b82023-01-03 15:35:25 +01001682component_test_full_no_bignum () {
1683 msg "build: full minus bignum"
1684 scripts/config.py full
1685 scripts/config.py unset MBEDTLS_BIGNUM_C
1686 # Direct dependencies of bignum
1687 scripts/config.py unset MBEDTLS_ECP_C
1688 scripts/config.py unset MBEDTLS_RSA_C
1689 scripts/config.py unset MBEDTLS_DHM_C
1690 # Direct dependencies of ECP
1691 scripts/config.py unset MBEDTLS_ECDH_C
1692 scripts/config.py unset MBEDTLS_ECDSA_C
1693 scripts/config.py unset MBEDTLS_ECJPAKE_C
1694 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001695 # Disable what auto-enables ECP_LIGHT
1696 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1697 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001698 # Indirect dependencies of ECP
1699 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1700 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1701 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1702 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1703 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1704 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1705 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1706 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1707 # Direct dependencies of DHM
1708 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1709 # Direct dependencies of RSA
1710 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1711 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1712 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1713 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1714 # PK and its dependencies
1715 scripts/config.py unset MBEDTLS_PK_C
1716 scripts/config.py unset MBEDTLS_PK_PARSE_C
1717 scripts/config.py unset MBEDTLS_PK_WRITE_C
1718 scripts/config.py unset MBEDTLS_X509_USE_C
1719 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1720 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1721 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1722 scripts/config.py unset MBEDTLS_X509_CREATE_C
1723 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1724 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1725 scripts/config.py unset MBEDTLS_PKCS7_C
1726 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1727 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1728 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1729
1730 make
1731
1732 msg "test: full minus bignum"
1733 make test
1734}
1735
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001736component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001737 msg "build: default with only stream cipher"
1738
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001739 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001740 scripts/config.py unset MBEDTLS_GCM_C
1741 scripts/config.py unset MBEDTLS_CCM_C
1742 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001743 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001744 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001745 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001746 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001747 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1748 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001749 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001750 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001751 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001752
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001753 make
1754
1755 msg "test: default with only stream cipher"
1756 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001757
1758 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001759}
1760
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001761component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001762 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001763
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001764 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001765 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001766 scripts/config.py unset MBEDTLS_GCM_C
1767 scripts/config.py unset MBEDTLS_CCM_C
1768 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001769 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel9550c052022-09-28 09:51:55 +02001770 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001771 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001772 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001773 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1774 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001775 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001776 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001777 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001778
Przemek Stekiel9550c052022-09-28 09:51:55 +02001779 make
1780
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001781 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001782 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001783
1784 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001785}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001786
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001787component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001788 msg "build: default with only CBC-legacy cipher"
1789
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001790 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001791 scripts/config.py unset MBEDTLS_GCM_C
1792 scripts/config.py unset MBEDTLS_CCM_C
1793 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001794 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1795 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1796 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001797 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001798 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001799 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001800 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001801 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001802 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001803
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001804 make
1805
1806 msg "test: default with only CBC-legacy cipher"
1807 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001808
1809 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1810 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001811}
1812
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001813component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001814 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001815
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001816 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001817 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001818 scripts/config.py unset MBEDTLS_GCM_C
1819 scripts/config.py unset MBEDTLS_CCM_C
1820 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001821 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1822 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1823 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001824 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001825 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001826 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001827 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001828 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001829 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001830
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001831 make
1832
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001833 msg "test: default with only CBC-legacy cipher use psa"
1834 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001835
1836 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1837 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001838}
1839
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001840component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001841 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1842
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001843 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001844 scripts/config.py unset MBEDTLS_GCM_C
1845 scripts/config.py unset MBEDTLS_CCM_C
1846 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001847 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1848 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1849 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1850 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1851 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001852 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001853 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001854 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001855 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001856
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001857 make
1858
1859 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1860 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001861
1862 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1863 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001864}
1865
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001866component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1867 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001868
1869 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001870 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001871 scripts/config.py unset MBEDTLS_GCM_C
1872 scripts/config.py unset MBEDTLS_CCM_C
1873 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001874 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1875 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1876 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1877 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1878 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001879 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001880 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001881 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001882 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001883
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001884 make
1885
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001886 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001887 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001888
1889 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1890 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001891}
1892
Valerio Setti9f0ec532022-11-08 13:03:24 +01001893# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1894# that we could use for interop testing. However, we now have sort of two
1895# implementations ourselves: one using PSA, the other not. At least test that
1896# these two interoperate with each other.
1897component_test_tls1_2_ecjpake_compatibility() {
1898 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1899 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001900 # Explicitly make lib first to avoid a race condition:
1901 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1902 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001903 make -C programs ssl/ssl_server2 ssl/ssl_client2
1904 cp programs/ssl/ssl_server2 s2_no_use_psa
1905 cp programs/ssl/ssl_client2 c2_no_use_psa
1906
1907 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1908 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1909 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001910 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001911 make -C programs ssl/ssl_server2 ssl/ssl_client2
1912 make -C programs test/udp_proxy test/query_compile_time_config
1913
Valerio Setti70e02902022-12-02 16:21:56 +01001914 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1915 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1916 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1917 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1918 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1919 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1920 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1921 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 +01001922
1923 rm s2_no_use_psa c2_no_use_psa
1924}
1925
Gilles Peskine636c26a2020-03-04 20:46:15 +01001926component_test_everest () {
1927 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
1928 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1929 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1930 make
1931
1932 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1933 make test
1934
Gilles Peskine6848d172023-11-02 19:58:03 +01001935 msg "test: metatests (clang, ASan)"
1936 tests/scripts/run-metatests.sh any asan
1937
Gilles Peskine636c26a2020-03-04 20:46:15 +01001938 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
1939 tests/ssl-opt.sh -f ECDH
1940
1941 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1942 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001943 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001944}
1945
Gilles Peskined3beca92020-07-03 00:15:37 +02001946component_test_everest_curve25519_only () {
1947 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02001948 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1949 scripts/config.py unset MBEDTLS_ECDSA_C
1950 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1951 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001952 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02001953 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001954 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02001955 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
1956
1957 make CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
1958
1959 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1960 make test
1961}
1962
Gilles Peskine8f073122018-11-27 15:58:47 +01001963component_test_small_ssl_out_content_len () {
1964 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001965 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1966 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Gilles Peskine8f073122018-11-27 15:58:47 +01001967 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1968 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001969
Gilles Peskine8f073122018-11-27 15:58:47 +01001970 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001971 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01001972}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001973
Gilles Peskine8f073122018-11-27 15:58:47 +01001974component_test_small_ssl_in_content_len () {
1975 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001976 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
1977 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Gilles Peskine8f073122018-11-27 15:58:47 +01001978 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1979 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001980
Gilles Peskine8f073122018-11-27 15:58:47 +01001981 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001982 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01001983}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001984
Gilles Peskine8f073122018-11-27 15:58:47 +01001985component_test_small_ssl_dtls_max_buffering () {
1986 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001987 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Gilles Peskine8f073122018-11-27 15:58:47 +01001988 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1989 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001990
Gilles Peskine8f073122018-11-27 15:58:47 +01001991 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001992 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 +01001993}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001994
Gilles Peskine8f073122018-11-27 15:58:47 +01001995component_test_small_mbedtls_ssl_dtls_max_buffering () {
1996 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001997 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Gilles Peskine8f073122018-11-27 15:58:47 +01001998 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1999 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002000
Gilles Peskine8f073122018-11-27 15:58:47 +01002001 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002002 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002003}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002004
Gilles Peskine75cc7712019-09-06 19:47:17 +02002005component_test_psa_collect_statuses () {
2006 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002007 scripts/config.py full
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002008 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002009 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002010 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002011 rm -f tests/statuses.log
2012}
2013
Gilles Peskine8f073122018-11-27 15:58:47 +01002014component_test_full_cmake_clang () {
2015 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002016 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002017 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 +01002018 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002019
k-stachowiak0291cb72019-06-26 15:52:12 +02002020 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002021 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002022
Gilles Peskineda6017c2022-10-30 21:02:40 +01002023 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2024 programs/test/cpp_dummy_build
2025
Gilles Peskine6848d172023-11-02 19:58:03 +01002026 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002027 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002028
Gilles Peskine82b27272019-06-14 18:27:03 +02002029 msg "program demos (full config, clang)" # ~10s
2030 tests/scripts/run_demos.py
2031
k-stachowiak0291cb72019-06-26 15:52:12 +02002032 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002033 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002034
Gilles Peskine8f073122018-11-27 15:58:47 +01002035 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002036 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002037
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002038 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002039 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002040
Gilles Peskine8f073122018-11-27 15:58:47 +01002041 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002042 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002043}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002044
Gilles Peskine0c671602022-11-29 16:01:41 +01002045skip_suites_without_constant_flow () {
2046 # Skip the test suites that don't have any constant-flow annotations.
2047 # This will need to be adjusted if we ever start declaring things as
2048 # secret from macros or functions inside tests/include or tests/src.
2049 SKIP_TEST_SUITES=$(
2050 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2051 sed 's/test_suite_//; s/\.function$//' |
2052 tr '\n' ,)
2053 export SKIP_TEST_SUITES
2054}
2055
Dave Rodgman246210e2023-07-31 18:07:44 +01002056skip_all_except_given_suite () {
2057 # Skip all but the given test suite
2058 SKIP_TEST_SUITES=$(
2059 ls -1 tests/suites/test_suite_*.function |
2060 grep -v $1.function |
2061 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2062 tr '\n' ,)
2063 export SKIP_TEST_SUITES
2064}
2065
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002066component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002067 # This tests both (1) accesses to undefined memory, and (2) branches or
2068 # memory access depending on secret values. To distinguish between those:
2069 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2070 # - or alternatively, change the build type to MemSanDbg, which enables
2071 # origin tracking and nicer stack traces (which are useful for debugging
2072 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002073 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2074 scripts/config.py full
2075 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2076 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2077 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2078 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2079 make
2080
2081 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2082 make test
2083}
2084
2085component_test_memsan_constant_flow_psa () {
2086 # This tests both (1) accesses to undefined memory, and (2) branches or
2087 # memory access depending on secret values. To distinguish between those:
2088 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2089 # - or alternatively, change the build type to MemSanDbg, which enables
2090 # origin tracking and nicer stack traces (which are useful for debugging
2091 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002092 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002093 scripts/config.py full
2094 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2095 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2096 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2097 make
2098
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002099 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002100 make test
2101}
2102
Bence Szépkúti0354d042023-12-06 16:14:37 +01002103component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002104 # This tests both (1) everything that valgrind's memcheck usually checks
2105 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2106 # etc.) and (2) branches or memory access depending on secret values,
2107 # which will be reported as uninitialized memory. To distinguish between
2108 # secret and actually uninitialized:
2109 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2110 # - or alternatively, build with debug info and manually run the offending
2111 # test suite with valgrind --track-origins=yes, then check if the origin
2112 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002113 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2114 scripts/config.py full
2115 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2116 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002117 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002118 cmake -D CMAKE_BUILD_TYPE:String=Release .
2119 make
2120
2121 # this only shows a summary of the results (how many of each type)
2122 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002123 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002124 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002125
2126 # Test asm path in constant time module - by default, it will test the plain C
2127 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2128 msg "test: valgrind asm constant_time"
2129 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2130 skip_all_except_given_suite test_suite_constant_time
2131 cmake -D CMAKE_BUILD_TYPE:String=Release .
2132 make clean
2133 make
2134 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002135}
2136
Bence Szépkúti0354d042023-12-06 16:14:37 +01002137component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002138 # This tests both (1) everything that valgrind's memcheck usually checks
2139 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2140 # etc.) and (2) branches or memory access depending on secret values,
2141 # which will be reported as uninitialized memory. To distinguish between
2142 # secret and actually uninitialized:
2143 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2144 # - or alternatively, build with debug info and manually run the offending
2145 # test suite with valgrind --track-origins=yes, then check if the origin
2146 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002147 msg "build: cmake release GCC, full config with constant flow testing"
2148 scripts/config.py full
2149 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002150 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002151 cmake -D CMAKE_BUILD_TYPE:String=Release .
2152 make
2153
2154 # this only shows a summary of the results (how many of each type)
2155 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002156 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002157 make memcheck
2158}
2159
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002160component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002161 # Test that removing the deprecated features from the default
2162 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002163 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2164 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
2165 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2166
2167 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2168 make test
2169}
2170
2171component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002172 msg "build: make, full_no_deprecated config" # ~ 30s
2173 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002174 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2175
Gilles Peskine30de2e82020-04-20 21:39:22 +02002176 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002177 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002178
2179 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2180 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002181}
2182
Gilles Peskine8386ea22020-04-30 09:07:29 +02002183component_test_full_no_deprecated_deprecated_warning () {
2184 # Test that there is nothing deprecated in "full_no_deprecated".
2185 # A deprecated feature would trigger a warning (made fatal) from
2186 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002187 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2188 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002189 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2190 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
2191 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2192
Gilles Peskine30de2e82020-04-20 21:39:22 +02002193 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002194 make test
2195}
2196
Gilles Peskine8386ea22020-04-30 09:07:29 +02002197component_test_full_deprecated_warning () {
2198 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2199 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002200 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002201 scripts/config.py full
2202 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002203 # Expect warnings from '#warning' directives in check_config.h.
2204 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002205
Gilles Peskine8386ea22020-04-30 09:07:29 +02002206 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2207 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2208 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002209 # Expect warnings from '#warning' directives in check_config.h and
2210 # from the use of deprecated functions in test suites.
2211 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 +01002212
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002213 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2214 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002215
2216 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2217 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002218}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002219
Gilles Peskineec541fe2020-01-31 14:24:14 +01002220# Check that the specified libraries exist and are empty.
2221are_empty_libraries () {
2222 nm "$@" >/dev/null 2>/dev/null
2223 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2224}
2225
2226component_build_crypto_default () {
2227 msg "build: make, crypto only"
2228 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002229 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002230 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002231}
2232
2233component_build_crypto_full () {
2234 msg "build: make, crypto only, full config"
2235 scripts/config.py crypto_full
Gilles Peskine6bb39152020-02-03 11:59:20 +01002236 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002237 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002238}
2239
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002240component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002241 msg "build: make, config for PSA crypto service"
2242 scripts/config.py crypto
2243 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2244 # Disable things that are not needed for just cryptography, to
2245 # reach a configuration that would be typical for a PSA cryptography
2246 # service providing all implemented PSA algorithms.
2247 # System stuff
2248 scripts/config.py unset MBEDTLS_ERROR_C
2249 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002250 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002251 # Crypto stuff with no PSA interface
2252 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002253 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002254 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002255 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002256 scripts/config.py unset MBEDTLS_NIST_KW_C
2257 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2258 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2259 scripts/config.py unset MBEDTLS_PKCS12_C
2260 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002261 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2262 # in PSA code to work with RSA keys. We don't require users to set those:
2263 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002264 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002265 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002266 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002267 make CFLAGS='-O1 -Werror' all test
2268 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2269}
2270
Gilles Peskineec541fe2020-01-31 14:24:14 +01002271component_build_crypto_baremetal () {
2272 msg "build: make, crypto only, baremetal config"
2273 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002274 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002275 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002276}
Daniel Axtens446af202020-09-02 21:30:13 +10002277support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002278 support_build_baremetal "$@"
2279}
2280
2281component_build_baremetal () {
2282 msg "build: make, baremetal config"
2283 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002284 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002285}
2286support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002287 # Older Glibc versions include time.h from other headers such as stdlib.h,
2288 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2289 # problem, Ubuntu 18.04 is ok.
2290 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2291}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002292
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002293# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002294component_test_depends_py_cipher_id () {
2295 msg "test/build: depends.py cipher_id (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002296 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002297}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002298
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002299component_test_depends_py_cipher_chaining () {
2300 msg "test/build: depends.py cipher_chaining (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002301 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002302}
2303
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002304component_test_depends_py_cipher_padding () {
2305 msg "test/build: depends.py cipher_padding (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002306 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002307}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002308
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002309component_test_depends_py_curves () {
2310 msg "test/build: depends.py curves (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002311 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002312}
2313
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002314component_test_depends_py_hashes () {
2315 msg "test/build: depends.py hashes (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002316 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002317}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002318
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002319component_test_depends_py_kex () {
2320 msg "test/build: depends.py kex (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002321 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002322}
2323
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002324component_test_depends_py_pkalgs () {
2325 msg "test/build: depends.py pkalgs (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002326 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002327}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002328
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002329# PSA equivalents of the depends.py tests
2330component_test_depends_py_cipher_id_psa () {
2331 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2332 tests/scripts/depends.py cipher_id
2333}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002334
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002335component_test_depends_py_cipher_chaining_psa () {
2336 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2337 tests/scripts/depends.py cipher_chaining
2338}
2339
2340component_test_depends_py_cipher_padding_psa () {
2341 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2342 tests/scripts/depends.py cipher_padding
2343}
2344
2345component_test_depends_py_curves_psa () {
2346 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2347 tests/scripts/depends.py curves
2348}
2349
2350component_test_depends_py_hashes_psa () {
2351 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2352 tests/scripts/depends.py hashes
2353}
2354
2355component_test_depends_py_kex_psa () {
2356 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2357 tests/scripts/depends.py kex
2358}
2359
2360component_test_depends_py_pkalgs_psa () {
2361 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002362 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002363}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002364
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002365component_build_no_pk_rsa_alt_support () {
2366 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2367
2368 scripts/config.py full
2369 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2370 scripts/config.py set MBEDTLS_RSA_C
2371 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2372
2373 # Only compile - this is primarily to test for compile issues
2374 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
2375}
2376
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002377component_build_module_alt () {
2378 msg "build: MBEDTLS_XXX_ALT" # ~30s
2379 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002380
2381 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002382 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2383 scripts/config.py unset MBEDTLS_AESNI_C
2384 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002385 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002386 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2387 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002388 # You can only have one threading implementation: alt or pthread, not both.
2389 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002390 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2391 # directly and assumes the implementation works with partial groups.
2392 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002393 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2394 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2395 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002396 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2397 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2398 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002399
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002400 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2401 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2402 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002403 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002404
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002405 # We can only compile, not link, since we don't have any implementations
2406 # suitable for testing with the dummy alt headers.
2407 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
2408}
2409
2410component_build_dhm_alt () {
2411 msg "build: MBEDTLS_DHM_ALT" # ~30s
2412 scripts/config.py full
2413 scripts/config.py set MBEDTLS_DHM_ALT
2414 # debug.c currently references mbedtls_dhm_context fields directly.
2415 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002416 # We can only compile, not link, since we don't have any implementations
2417 # suitable for testing with the dummy alt headers.
2418 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
2419}
2420
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002421component_test_no_use_psa_crypto_full_cmake_asan() {
2422 # full minus MBEDTLS_USE_PSA_CRYPTO: run the same set of tests as basic-build-test.sh
Gilles Peskinedc3a1792019-09-03 11:42:04 +02002423 msg "build: cmake, full config minus MBEDTLS_USE_PSA_CRYPTO, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002424 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002425 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
2426 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002427 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002428 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002429 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002430 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002431 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002432 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Manuel Pégourié-Gonnardd8167e82019-02-01 11:12:52 +01002433 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002434 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002435
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002436 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002437 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002438
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002439 # Note: ssl-opt.sh has some test cases that depend on
2440 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2441 # This is the only component where those tests are not skipped.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002442 msg "test: ssl-opt.sh (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002443 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002444
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002445 msg "test: compat.sh default (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002446 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002447
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002448 msg "test: compat.sh NULL (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002449 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002450
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002451 msg "test: compat.sh ARIA + ChachaPoly (full minus MBEDTLS_USE_PSA_CRYPTO)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002452 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002453}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002454
Ronald Cron403c15c2021-09-13 09:38:05 +02002455component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002456 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002457
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002458 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002459 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002460 $(helper_get_psa_key_type_list "ECC") \
2461 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002462
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002463 # Configure
2464 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002465
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002466 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002467 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard6d7db932022-12-28 09:48:01 +01002468 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002469
2470 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002471 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002472
2473 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002474 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2475 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2476
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002477 # Build
2478 # -----
2479
2480 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002481 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2482 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002483
2484 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2485
Valerio Setti3fe105b2023-10-30 11:08:12 +01002486 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002487
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002488 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002489 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002490
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002491 # Run the tests
2492 # -------------
2493
Ronald Cron403c15c2021-09-13 09:38:05 +02002494 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2495 make test
2496}
2497
Valerio Setti44b178c2023-03-22 14:02:57 +01002498component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002499 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002500
2501 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002502 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002503 $(helper_get_psa_key_type_list "ECC") \
2504 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002505
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002506 # Configure
2507 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002508
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002509 # Start from default config (no TLS 1.3, no USE_PSA)
2510 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002511
Valerio Setti44b178c2023-03-22 14:02:57 +01002512 # Disable the module that's accelerated
2513 scripts/config.py unset MBEDTLS_ECDH_C
2514
2515 # Disable things that depend on it
2516 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2517 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2518 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2519 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2520 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2521
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002522 # Build
2523 # -----
2524
2525 helper_libtestdriver1_make_drivers "$loc_accel_list"
2526
Valerio Setti3fe105b2023-10-30 11:08:12 +01002527 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002528
Valerio Setti44b178c2023-03-22 14:02:57 +01002529 # Make sure this was not re-enabled by accident (additive config)
2530 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002531
2532 # Run the tests
2533 # -------------
2534
Valerio Setti44b178c2023-03-22 14:02:57 +01002535 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002536 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002537}
2538
Przemek Stekieldccb2022023-05-11 10:48:50 +02002539component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002540 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002541
2542 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002543 loc_accel_list="ALG_FFDH \
Valerio Setti0a342c92023-09-01 09:12:31 +02002544 $(helper_get_psa_key_type_list "DH")"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002545
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002546 # Configure
2547 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002548
Przemek Stekiel565353e2023-07-05 11:07:07 +02002549 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002550 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002551
2552 # Disable the module that's accelerated
2553 scripts/config.py unset MBEDTLS_DHM_C
2554
2555 # Disable things that depend on it
2556 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2557 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2558
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002559 # Build
2560 # -----
2561
2562 helper_libtestdriver1_make_drivers "$loc_accel_list"
2563
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002564 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002565
2566 # Make sure this was not re-enabled by accident (additive config)
2567 not grep mbedtls_dhm_ library/dhm.o
2568
2569 # Run the tests
2570 # -------------
2571
Gilles Peskine14302ed2023-07-19 19:30:04 +02002572 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002573 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002574
Gilles Peskine14302ed2023-07-19 19:30:04 +02002575 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002576 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002577}
2578
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002579component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002580 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002581
2582 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002583 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002584
2585 # Disable things that are not supported
2586 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2587 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002588 make
2589
Gilles Peskine14302ed2023-07-19 19:30:04 +02002590 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002591 make test
2592
Gilles Peskine14302ed2023-07-19 19:30:04 +02002593 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002594 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002595}
2596
Valerio Setti44b178c2023-03-22 14:02:57 +01002597component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002598 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002599
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002600 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002601 $(helper_get_psa_key_type_list "ECC") \
2602 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002603
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002604 # Configure
2605 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002606
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002607 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002608
2609 # Make built-in fallback not available
2610 scripts/config.py unset MBEDTLS_ECJPAKE_C
2611 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2612
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002613 # Build
2614 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002615
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002616 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002617
Valerio Setti3fe105b2023-10-30 11:08:12 +01002618 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002619
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002620 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002621 not grep mbedtls_ecjpake_init library/ecjpake.o
2622
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002623 # Run the tests
2624 # -------------
2625
Gilles Peskine14302ed2023-07-19 19:30:04 +02002626 msg "test: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002627 make test
2628}
2629
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002630component_test_psa_crypto_config_accel_ecc_some_key_types () {
2631 msg "build: full with accelerated EC algs and some key types"
2632
2633 # Algorithms and key types to accelerate
2634 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2635 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2636 ALG_ECDH \
2637 ALG_JPAKE \
2638 KEY_TYPE_ECC_PUBLIC_KEY \
2639 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2640 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002641 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2642 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002643
2644 # Configure
2645 # ---------
2646
2647 # start with config full for maximum coverage (also enables USE_PSA)
2648 helper_libtestdriver1_adjust_config "full"
2649
2650 # Disable modules that are accelerated - some will be re-enabled
2651 scripts/config.py unset MBEDTLS_ECDSA_C
2652 scripts/config.py unset MBEDTLS_ECDH_C
2653 scripts/config.py unset MBEDTLS_ECJPAKE_C
2654 scripts/config.py unset MBEDTLS_ECP_C
2655
2656 # Disable all curves - those that aren't accelerated should be re-enabled
2657 helper_disable_builtin_curves
2658
2659 # Restartable feature is not yet supported by PSA. Once it will in
2660 # the future, the following line could be removed (see issues
2661 # 6061, 6332 and following ones)
2662 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2663
2664 # this is not supported by the driver API yet
2665 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2666
2667 # Build
2668 # -----
2669
2670 # These hashes are needed for some ECDSA signature tests.
2671 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2672 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2673 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2674
Valerio Setti3fe105b2023-10-30 11:08:12 +01002675 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002676
2677 # ECP should be re-enabled but not the others
2678 not grep mbedtls_ecdh_ library/ecdh.o
2679 not grep mbedtls_ecdsa library/ecdsa.o
2680 not grep mbedtls_ecjpake library/ecjpake.o
2681 grep mbedtls_ecp library/ecp.o
2682
2683 # Run the tests
2684 # -------------
2685
2686 msg "test suites: full with accelerated EC algs and some key types"
2687 make test
2688}
2689
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002690# Run tests with only (non-)Weierstrass accelerated
2691# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002692# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2693# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002694common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002695 weierstrass=$1
2696 if [ $weierstrass -eq 1 ]; then
2697 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002698 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002699 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002700 fi
2701
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002702 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002703
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002704 # Note: Curves are handled in a special way by the libtestdriver machinery,
2705 # so we only want to include them in the accel list when building the main
2706 # libraries, hence the use of a separate variable.
2707 # Note: the following loop is a modified version of
2708 # helper_get_psa_curve_list that only keeps Weierstrass families.
2709 loc_weierstrass_list=""
2710 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002711 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2712 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002713 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002714 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002715 ;;
2716 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002717 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002718 ;;
2719 esac
2720 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002721 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002722 loc_curve_list=$loc_weierstrass_list
2723 else
2724 loc_curve_list=$loc_non_weierstrass_list
2725 fi
2726
Valerio Setti3fe105b2023-10-30 11:08:12 +01002727 # Algorithms and key types to accelerate
2728 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2729 ALG_ECDH \
2730 ALG_JPAKE \
2731 $(helper_get_psa_key_type_list "ECC") \
2732 $loc_curve_list"
2733
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002734 # Configure
2735 # ---------
2736
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002737 # Start with config crypto_full and remove PK_C:
2738 # that's what's supported now, see docs/driver-only-builds.md.
2739 helper_libtestdriver1_adjust_config "crypto_full"
2740 scripts/config.py unset MBEDTLS_PK_C
2741 scripts/config.py unset MBEDTLS_PK_PARSE_C
2742 scripts/config.py unset MBEDTLS_PK_WRITE_C
2743 # We need to disable RSA too or PK will be re-enabled.
2744 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
2745 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_ALG_RSA_[0-9A-Z_a-z]*"
2746 scripts/config.py unset MBEDTLS_RSA_C
2747 scripts/config.py unset MBEDTLS_PKCS1_V15
2748 scripts/config.py unset MBEDTLS_PKCS1_V21
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002749
2750 # Disable modules that are accelerated - some will be re-enabled
2751 scripts/config.py unset MBEDTLS_ECDSA_C
2752 scripts/config.py unset MBEDTLS_ECDH_C
2753 scripts/config.py unset MBEDTLS_ECJPAKE_C
2754 scripts/config.py unset MBEDTLS_ECP_C
2755
2756 # Disable all curves - those that aren't accelerated should be re-enabled
2757 helper_disable_builtin_curves
2758
2759 # Restartable feature is not yet supported by PSA. Once it will in
2760 # the future, the following line could be removed (see issues
2761 # 6061, 6332 and following ones)
2762 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2763
2764 # this is not supported by the driver API yet
2765 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2766
2767 # Build
2768 # -----
2769
2770 # These hashes are needed for some ECDSA signature tests.
2771 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2772 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2773 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2774
Valerio Settiac7a8092023-10-31 12:23:44 +01002775 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002776
2777 # We expect ECDH to be re-enabled for the missing curves
2778 grep mbedtls_ecdh_ library/ecdh.o
2779 # We expect ECP to be re-enabled, however the parts specific to the
2780 # families of curves that are accelerated should be ommited.
2781 # - functions with mxz in the name are specific to Montgomery curves
2782 # - ecp_muladd is specific to Weierstrass curves
2783 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002784 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002785 not grep mbedtls_ecp_muladd library/ecp.o
2786 grep mxz library/ecp.o
2787 else
2788 grep mbedtls_ecp_muladd library/ecp.o
2789 not grep mxz library/ecp.o
2790 fi
2791 # We expect ECDSA and ECJPAKE to be re-enabled only when
2792 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002793 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002794 not grep mbedtls_ecdsa library/ecdsa.o
2795 not grep mbedtls_ecjpake library/ecjpake.o
2796 else
2797 grep mbedtls_ecdsa library/ecdsa.o
2798 grep mbedtls_ecjpake library/ecjpake.o
2799 fi
2800
2801 # Run the tests
2802 # -------------
2803
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002804 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2805 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002806}
2807
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002808component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002809 common_test_psa_crypto_config_accel_ecc_some_curves 1
2810}
2811
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002812component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002813 common_test_psa_crypto_config_accel_ecc_some_curves 0
2814}
2815
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002816# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2817# ECDH, ECDSA) with and without drivers.
2818# The input parameter is a boolean value which indicates:
2819# - 0 keep built-in EC algs,
2820# - 1 exclude built-in EC algs (driver only).
2821#
2822# This is used by the two following components to ensure they always use the
2823# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002824# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2825# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002826# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002827config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002828 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002829 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002830 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002831 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002832 # Disable modules that are accelerated
2833 scripts/config.py unset MBEDTLS_ECDSA_C
2834 scripts/config.py unset MBEDTLS_ECDH_C
2835 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002836 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002837 fi
2838
2839 # Restartable feature is not yet supported by PSA. Once it will in
2840 # the future, the following line could be removed (see issues
2841 # 6061, 6332 and following ones)
2842 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002843}
2844
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002845# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2846component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002847 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002848
2849 # Algorithms and key types to accelerate
2850 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2851 ALG_ECDH \
2852 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002853 $(helper_get_psa_key_type_list "ECC") \
2854 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002855
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002856 # Configure
2857 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002858
2859 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002860 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002861
Valerio Setti0a342c92023-09-01 09:12:31 +02002862 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002863 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2864 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002865
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002866 # Build
2867 # -----
2868
2869 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002870 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2871 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002872 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2873
Valerio Setti3fe105b2023-10-30 11:08:12 +01002874 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002875
2876 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2877 not grep mbedtls_ecdsa_ library/ecdsa.o
2878 not grep mbedtls_ecdh_ library/ecdh.o
2879 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002880 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002881
2882 # Run the tests
2883 # -------------
2884
Gilles Peskine14302ed2023-07-19 19:30:04 +02002885 msg "test suites: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002886 make test
2887
Gilles Peskine14302ed2023-07-19 19:30:04 +02002888 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002889 tests/ssl-opt.sh
2890}
2891
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002892# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2893component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002894 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002895
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002896 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002897
2898 make
2899
Gilles Peskine14302ed2023-07-19 19:30:04 +02002900 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002901 make test
2902
Gilles Peskine14302ed2023-07-19 19:30:04 +02002903 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002904 tests/ssl-opt.sh
2905}
2906
Valerio Settie618cb02023-04-12 14:59:16 +02002907# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002908# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2909# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002910# to ensure that both tests use the same underlying configuration when testing
2911# driver's coverage with analyze_outcomes.py.
2912#
2913# This functions accepts 1 boolean parameter as follows:
2914# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2915# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2916# - 0: include built-in implementation of EC algorithms.
2917#
2918# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2919# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002920config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002921 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002922 # start with full config for maximum coverage (also enables USE_PSA)
2923 helper_libtestdriver1_adjust_config "full"
2924
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002925 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002926 # Disable modules that are accelerated
2927 scripts/config.py unset MBEDTLS_ECDSA_C
2928 scripts/config.py unset MBEDTLS_ECDH_C
2929 scripts/config.py unset MBEDTLS_ECJPAKE_C
2930 # Disable ECP module (entirely)
2931 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002932 fi
2933
Valerio Settiaecd32c2023-06-14 10:42:31 +02002934 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2935 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002936 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002937 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002938
Valerio Settie618cb02023-04-12 14:59:16 +02002939 # Restartable feature is not yet supported by PSA. Once it will in
2940 # the future, the following line could be removed (see issues
2941 # 6061, 6332 and following ones)
2942 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002943}
2944
2945# Build and test a configuration where driver accelerates all EC algs while
2946# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2947# side.
2948#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002949# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2950component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002951 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002952
2953 # Algorithms and key types to accelerate
2954 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2955 ALG_ECDH \
2956 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002957 $(helper_get_psa_key_type_list "ECC") \
2958 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02002959
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002960 # Configure
2961 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002962
Valerio Settie618cb02023-04-12 14:59:16 +02002963 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002964 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02002965 # Disable all the builtin curves. All the required algs are accelerated.
2966 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02002967
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002968 # Build
2969 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02002970
2971 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002972 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
2973 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2974 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02002975
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02002976 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02002977
Valerio Setti3fe105b2023-10-30 11:08:12 +01002978 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02002979
2980 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2981 not grep mbedtls_ecdsa_ library/ecdsa.o
2982 not grep mbedtls_ecdh_ library/ecdh.o
2983 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02002984 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02002985 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02002986
2987 # Run the tests
2988 # -------------
2989
Gilles Peskine14302ed2023-07-19 19:30:04 +02002990 msg "test: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002991 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02002992
Gilles Peskine14302ed2023-07-19 19:30:04 +02002993 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02002994 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02002995}
2996
2997# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002998# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02002999# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003000component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003001 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003002
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003003 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003004
3005 make
3006
Gilles Peskine14302ed2023-07-19 19:30:04 +02003007 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003008 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003009
Gilles Peskine14302ed2023-07-19 19:30:04 +02003010 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003011 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003012}
3013
Valerio Setti4e2f2442023-08-15 10:10:26 +02003014# This is a common configuration helper used directly from:
3015# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3016# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3017# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003018# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003019# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003020# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003021# - this is the reference component of the above
3022# - it still disables RSA and FFDH, but it uses builtin EC algs
3023# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3024# - accelerate all EC and FFDH algs, disable only RSA
3025# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3026# - this is the reference component of the above
3027# - it still disables RSA, but it uses builtin EC and FFDH algs
3028#
3029# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003030# $1: a boolean value which states if we are testing an accelerated scenario
3031# or not.
3032# $2: a string value which states which components are tested. Allowed values
3033# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003034config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003035 driver_only="$1"
3036 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003037 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003038 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003039
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003040 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003041 # Disable modules that are accelerated
3042 scripts/config.py unset MBEDTLS_ECDSA_C
3043 scripts/config.py unset MBEDTLS_ECDH_C
3044 scripts/config.py unset MBEDTLS_ECJPAKE_C
3045 # Disable ECP module (entirely)
3046 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003047 # Also disable bignum
3048 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003049 fi
3050
3051 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3052 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3053 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3054 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3055
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003056 # RSA support is intentionally disabled on this test because RSA_C depends
3057 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003058 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3059 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 +02003060 scripts/config.py unset MBEDTLS_RSA_C
3061 scripts/config.py unset MBEDTLS_PKCS1_V15
3062 scripts/config.py unset MBEDTLS_PKCS1_V21
3063 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3064 # Also disable key exchanges that depend on RSA
3065 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3066 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3067 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3068 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3069 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3070
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003071 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003072 # When testing ECC only, we disable FFDH support, both from builtin and
3073 # PSA sides, and also disable the key exchanges that depend on DHM.
3074 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3075 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
3076 scripts/config.py unset MBEDTLS_DHM_C
3077 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3078 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3079 else
3080 # When testing ECC and DH instead, we disable DHM and depending key
3081 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003082 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003083 scripts/config.py unset MBEDTLS_DHM_C
3084 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3085 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3086 fi
3087 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003088
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003089 # Restartable feature is not yet supported by PSA. Once it will in
3090 # the future, the following line could be removed (see issues
3091 # 6061, 6332 and following ones)
3092 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3093}
3094
Valerio Setti4e2f2442023-08-15 10:10:26 +02003095# Common helper used by:
3096# - component_test_psa_crypto_config_accel_ecc_no_bignum
3097# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003098#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003099# The goal is to build and test accelerating either:
3100# - ECC only or
3101# - both ECC and FFDH
3102#
3103# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003104# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3105# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003106common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003107 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003108
Valerio Setti5dfaca42023-09-05 08:48:51 +02003109 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003110 if [ "$test_target" = "ECC_DH" ]; then
3111 accel_text="ECC/FFDH"
3112 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003113 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003114 accel_text="ECC"
3115 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003116 fi
3117
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003118 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003119
3120 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003121 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3122 ALG_ECDH \
3123 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003124 $(helper_get_psa_key_type_list "ECC") \
3125 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003126 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003127 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003128 loc_accel_list="$loc_accel_list \
3129 ALG_FFDH \
Manuel Pégourié-Gonnard85ff5e62023-09-22 09:05:48 +02003130 $(helper_get_psa_key_type_list "DH")"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003131 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003132
3133 # Configure
3134 # ---------
3135
3136 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003137 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003138 # Disable all the builtin curves. All the required algs are accelerated.
3139 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003140
3141 # Build
3142 # -----
3143
3144 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003145 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3146 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3147 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003148
3149 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3150
Valerio Setti3fe105b2023-10-30 11:08:12 +01003151 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003152
3153 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3154 not grep mbedtls_ecdsa_ library/ecdsa.o
3155 not grep mbedtls_ecdh_ library/ecdh.o
3156 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003157 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003158 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003159 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003160 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003161 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003162
3163 # Run the tests
3164 # -------------
3165
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003166 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003167
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003168 make test
3169
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003170 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003171 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003172}
3173
Valerio Setti4e2f2442023-08-15 10:10:26 +02003174# Common helper used by:
3175# - component_test_psa_crypto_config_reference_ecc_no_bignum
3176# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3177#
3178# The goal is to build and test a reference scenario (i.e. with builtin
3179# components) compared to the ones used in
3180# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3181#
3182# It is meant to be used in conjunction with
3183# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3184# coverage analysis in "analyze_outcomes.py" script.
3185common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003186 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003187
Valerio Setti5dfaca42023-09-05 08:48:51 +02003188 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003189 if [ "$test_target" = "ECC_DH" ]; then
3190 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003191 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003192 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003193 fi
3194
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003195 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003196
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003197 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003198
3199 make
3200
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003201 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003202 make test
3203
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003204 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003205 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003206}
3207
Valerio Setti4e2f2442023-08-15 10:10:26 +02003208component_test_psa_crypto_config_accel_ecc_no_bignum () {
3209 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3210}
3211
3212component_test_psa_crypto_config_reference_ecc_no_bignum () {
3213 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3214}
3215
3216component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3217 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3218}
3219
3220component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3221 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3222}
3223
Valerio Settiac6d35f2023-08-04 12:49:11 +02003224# Helper for setting common configurations between:
3225# - component_test_tfm_config_p256m_driver_accel_ec()
3226# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003227common_tfm_config () {
3228 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003229 cp configs/config-tfm.h "$CONFIG_H"
3230 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3231 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003232
Yanray Wang73bb2312023-09-25 11:21:15 +08003233 # Other config adjustment to make the tests pass.
3234 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003235 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003236 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3237 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003238
Yanray Wang73bb2312023-09-25 11:21:15 +08003239 # Config adjustment for better test coverage in our environment.
3240 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003241 #
3242 # Enable filesystem I/O for the benefit of PK parse/write tests.
3243 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3244}
3245
Valerio Settiac6d35f2023-08-04 12:49:11 +02003246# Keep this in sync with component_test_tfm_config() as they are both meant
3247# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003248component_test_tfm_config_p256m_driver_accel_ec () {
3249 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3250
3251 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003252
Dave Rodgman897bb772023-11-15 16:34:20 +00003253 # Build crypto library
3254 make CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003255
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003256 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3257 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003258 not grep mbedtls_ecdh_ library/ecdh.o
3259 not grep mbedtls_ecjpake_ library/ecjpake.o
3260 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3261 not grep mbedtls_ecp_ library/ecp.o
3262 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003263 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003264 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003265 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003266 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003267
Valerio Setti5e18b902023-12-04 12:07:30 +01003268 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3269 # files, so we want to ensure that it has not be re-enabled accidentally.
3270 not grep mbedtls_cipher library/cipher.o
3271
Valerio Settib7e95442023-03-21 11:52:33 +01003272 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003273 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003274 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003275}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003276
Valerio Settiac6d35f2023-08-04 12:49:11 +02003277# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3278# they are both meant to be used in analyze_outcomes.py for driver's coverage
3279# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003280component_test_tfm_config() {
3281 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003282
Dave Rodgman897bb772023-11-15 16:34:20 +00003283 # Disable P256M driver, which is on by default, so that analyze_outcomes
3284 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3285 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3286
Valerio Setti52ba0e32023-08-04 12:43:03 +02003287 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003288 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003289
Dave Rodgman897bb772023-11-15 16:34:20 +00003290 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003291 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003292
Valerio Setti5e18b902023-12-04 12:07:30 +01003293 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3294 # files, so we want to ensure that it has not be re-enabled accidentally.
3295 not grep mbedtls_cipher library/cipher.o
3296
Valerio Setti52ba0e32023-08-04 12:43:03 +02003297 msg "test: TF-M config"
3298 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003299}
3300
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003301# Common helper for component_full_without_ecdhe_ecdsa() and
3302# component_full_without_ecdhe_ecdsa_and_tls13() which:
3303# - starts from the "full" configuration minus the list of symbols passed in
3304# as 1st parameter
3305# - build
3306# - test only TLS (i.e. test_suite_tls and ssl-opt)
3307build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003308 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003309
3310 msg "build: full minus something, test TLS"
3311
3312 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003313 for sym in $symbols_to_disable; do
3314 echo "Disabling $sym"
3315 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003316 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003317
Valerio Settiee97a1e2023-03-27 12:44:15 +02003318 make
3319
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003320 msg "test: full minus something, test TLS"
3321 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003322
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003323 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003324 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003325}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003326
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003327component_full_without_ecdhe_ecdsa () {
3328 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003329}
3330
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003331component_full_without_ecdhe_ecdsa_and_tls13 () {
3332 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3333 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003334}
3335
Valerio Setti249b18a2023-06-20 12:08:30 +02003336# This is an helper used by:
3337# - component_test_psa_ecc_key_pair_no_derive
3338# - component_test_psa_ecc_key_pair_no_generate
3339# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3340# enabled, but one. Input arguments are as follows:
3341# - $1 is the key type under test, i.e. ECC/RSA/DH
3342# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003343build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003344 key_type=$1
3345 unset_option=$2
3346 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003347
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003348 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003349 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003350 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3351 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3352
3353 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3354 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003355 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003356
Valerio Settif6587be2023-06-22 11:33:14 +02003357 make CC=gcc CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003358
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003359 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003360 make test
3361}
3362
3363component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003364 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003365}
3366
3367component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003368 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003369}
3370
Ronald Cron403c15c2021-09-13 09:38:05 +02003371component_test_psa_crypto_config_accel_rsa_signature () {
3372 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated RSA signature"
3373
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003374 loc_accel_list="ALG_RSA_PKCS1V15_SIGN ALG_RSA_PSS KEY_TYPE_RSA_KEY_PAIR KEY_TYPE_RSA_PUBLIC_KEY"
3375
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003376 # Configure
3377 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003378
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003379 # Start from default config (no TLS 1.3, no USE_PSA)
3380 helper_libtestdriver1_adjust_config "default"
Ronald Cron403c15c2021-09-13 09:38:05 +02003381
3382 # It seems it is not possible to remove only the support for RSA signature
3383 # in the library. Thus we have to remove all RSA support (signature and
3384 # encryption/decryption). AS there is no driver support for asymmetric
3385 # encryption/decryption so far remove RSA encryption/decryption from the
3386 # application algorithm list.
Ronald Cron6b49b552023-07-20 09:57:54 +02003387 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
3388 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
Ronald Cron403c15c2021-09-13 09:38:05 +02003389
Manuel Pégourié-Gonnardaed1d782023-06-12 17:22:24 +02003390 # Remove RSA support and its dependencies
3391 scripts/config.py unset MBEDTLS_RSA_C
3392 scripts/config.py unset MBEDTLS_PKCS1_V15
3393 scripts/config.py unset MBEDTLS_PKCS1_V21
3394 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3395 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3396 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3397 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3398 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3399 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3400
Ronald Cron403c15c2021-09-13 09:38:05 +02003401 # Make sure both the library and the test library support the SHA hash
3402 # algorithms and only those ones (SHA256 is included by default). That way:
3403 # - the test library can compute the RSA signatures even in the case of a
3404 # composite RSA signature algorithm based on a SHA hash (no other hash
3405 # used in the unit tests).
3406 # - the dependency of RSA signature tests on PSA_WANT_ALG_SHA_xyz is
3407 # fulfilled as the hash SHA algorithm is supported by the library, and
3408 # thus the tests are run, not skipped.
3409 # - when testing a signature key with an algorithm wildcard built from
3410 # PSA_ALG_ANY_HASH as algorithm to test with the key, the chosen hash
3411 # algorithm based on the hashes supported by the library is also
3412 # supported by the test library.
Manuel Pégourié-Gonnardaed1d782023-06-12 17:22:24 +02003413 # Disable unwanted hashes here, we'll enable hashes we want in loc_extra_list.
Ronald Cron6b49b552023-07-20 09:57:54 +02003414 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3415 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160_C
Ronald Cron403c15c2021-09-13 09:38:05 +02003416 scripts/config.py unset MBEDTLS_MD5_C
3417 scripts/config.py unset MBEDTLS_RIPEMD160_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003418
3419 # We need PEM parsing in the test library as well to support the import
3420 # of PEM encoded RSA keys.
Ronald Cron7612d8c2023-07-20 10:03:54 +02003421 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3422 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003423
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003424 # Build
3425 # -----
3426
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003427 # These hashes are needed for some RSA-PSS signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003428 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3429 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003430 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003431
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003432 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003433
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003434 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01003435 not grep mbedtls_rsa_rsassa_pkcs1_v15_sign library/rsa.o
3436 not grep mbedtls_rsa_rsassa_pss_sign_ext library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003437
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003438 # Run the tests
3439 # -------------
3440
Ronald Cron403c15c2021-09-13 09:38:05 +02003441 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated RSA signature"
3442 make test
3443}
3444
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003445# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003446# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003447component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003448 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003449
Valerio Setti4590bc22023-06-13 15:39:23 +02003450 # Create a temporary output file unless there is already one set
3451 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3452 REMOVE_OUTCOME_ON_EXIT="no"
3453 else
3454 REMOVE_OUTCOME_ON_EXIT="yes"
3455 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3456 export MBEDTLS_TEST_OUTCOME_FILE
3457 fi
3458
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003459 # Start from crypto configuration
3460 scripts/config.py crypto
3461
3462 # Remove RSA support and its dependencies
3463 scripts/config.py unset MBEDTLS_PKCS1_V15
3464 scripts/config.py unset MBEDTLS_PKCS1_V21
3465 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3466 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3467 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3468 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3469 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3470 scripts/config.py unset MBEDTLS_RSA_C
3471 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3472
3473 # Enable PSA support
3474 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3475
Valerio Setti01cc88a2023-06-15 11:53:08 +02003476 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003477 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003478 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3479 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3480 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003481
3482 make
3483
Valerio Setti01cc88a2023-06-15 11:53:08 +02003484 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003485 make test
3486
3487 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3488 # performing RSA signature.
3489 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3490 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3491
3492 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3493 rm $MBEDTLS_TEST_OUTCOME_FILE
3494 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003495}
3496
Ronald Cronb2312452021-05-08 14:32:59 +02003497component_test_psa_crypto_config_accel_hash () {
3498 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3499
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003500 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3501 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3502 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003503
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003504 # Configure
3505 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003506
3507 # Start from default config (no TLS 1.3, no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003508 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003509
3510 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003511 scripts/config.py unset MBEDTLS_MD5_C
3512 scripts/config.py unset MBEDTLS_RIPEMD160_C
3513 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003514 scripts/config.py unset MBEDTLS_SHA224_C
3515 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003516 scripts/config.py unset MBEDTLS_SHA384_C
3517 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003518 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003519
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003520 # Build
3521 # -----
3522
3523 helper_libtestdriver1_make_drivers "$loc_accel_list"
3524
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003525 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003526
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003527 # There's a risk of something getting re-enabled via config_psa.h;
3528 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3529 not grep mbedtls_md5 library/md5.o
3530 not grep mbedtls_sha1 library/sha1.o
3531 not grep mbedtls_sha256 library/sha256.o
3532 not grep mbedtls_sha512 library/sha512.o
3533 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003534
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003535 # Run the tests
3536 # -------------
3537
Ronald Cronb2312452021-05-08 14:32:59 +02003538 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3539 make test
3540}
3541
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003542component_test_psa_crypto_config_accel_hash_keep_builtins () {
3543 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3544 # This component ensures that all the test cases for
3545 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3546
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003547 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3548 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3549 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003550
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003551 # Start from default config (no TLS 1.3, no USE_PSA)
3552 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003553
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003554 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003555
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003556 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003557
3558 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3559 make test
3560}
3561
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003562# Auxiliary function to build config for hashes with and without drivers
3563config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003564 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003565 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003566 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003567 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003568 # disable the built-in implementation of hashes
3569 scripts/config.py unset MBEDTLS_MD5_C
3570 scripts/config.py unset MBEDTLS_RIPEMD160_C
3571 scripts/config.py unset MBEDTLS_SHA1_C
3572 scripts/config.py unset MBEDTLS_SHA224_C
3573 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003574 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003575 scripts/config.py unset MBEDTLS_SHA384_C
3576 scripts/config.py unset MBEDTLS_SHA512_C
3577 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003578 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003579 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003580}
3581
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003582# Note that component_test_psa_crypto_config_reference_hash_use_psa
3583# is related to this component and both components need to be kept in sync.
3584# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003585component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003586 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003587
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003588 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3589 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3590 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003591
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003592 # Configure
3593 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003594
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003595 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003596
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003597 # Build
3598 # -----
3599
3600 helper_libtestdriver1_make_drivers "$loc_accel_list"
3601
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003602 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003603
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003604 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003605 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003606 not grep mbedtls_md5 library/md5.o
3607 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003608 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003609 not grep mbedtls_sha512 library/sha512.o
3610 not grep mbedtls_ripemd160 library/ripemd160.o
3611
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003612 # Run the tests
3613 # -------------
3614
Gilles Peskine14302ed2023-07-19 19:30:04 +02003615 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003616 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003617
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003618 # This is mostly useful so that we can later compare outcome files with
3619 # the reference config in analyze_outcomes.py, to check that the
3620 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003621 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003622 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003623
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003624 # This is to make sure all ciphersuites are exercised, but we don't need
3625 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003626 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003627 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003628}
3629
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003630# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3631# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3632# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3633# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003634component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003635 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003636
3637 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003638
Przemek Stekielab0451b2022-10-24 11:29:35 +02003639 make
3640
Gilles Peskine14302ed2023-07-19 19:30:04 +02003641 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003642 make test
3643
Gilles Peskine14302ed2023-07-19 19:30:04 +02003644 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003645 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003646}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003647
John Durkop4377bf72020-10-23 01:26:57 -07003648component_test_psa_crypto_config_accel_cipher () {
3649 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated cipher"
3650
Valerio Setti0244fbb2023-10-19 10:42:31 +02003651 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3652 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3653 KEY_TYPE_DES"
John Durkop1b7ee052020-11-27 08:51:22 -08003654
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003655 # Configure
3656 # ---------
John Durkop1b7ee052020-11-27 08:51:22 -08003657
Valerio Setti9a427302023-10-17 11:40:42 +02003658 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003659 helper_libtestdriver1_adjust_config "full"
John Durkop1b7ee052020-11-27 08:51:22 -08003660
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003661 # Disable the things that are being accelerated
John Durkop1b7ee052020-11-27 08:51:22 -08003662 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3663 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3664 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3665 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3666 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3667 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3668 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003669 scripts/config.py unset MBEDTLS_CMAC_C
John Durkop1b7ee052020-11-27 08:51:22 -08003670
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003671 # Build
3672 # -----
John Durkop1b7ee052020-11-27 08:51:22 -08003673
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003674 helper_libtestdriver1_make_drivers "$loc_accel_list"
3675
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003676 helper_libtestdriver1_make_main "$loc_accel_list"
John Durkop1b7ee052020-11-27 08:51:22 -08003677
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003678 # Make sure this was not re-enabled by accident (additive config)
John Durkop1b7ee052020-11-27 08:51:22 -08003679 not grep mbedtls_des* library/des.o
3680
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003681 # Run the tests
3682 # -------------
3683
John Durkop1b7ee052020-11-27 08:51:22 -08003684 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated cipher"
3685 make test
3686}
3687
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003688component_test_psa_crypto_config_accel_aead () {
3689 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3690
Valerio Setti3f02bb72023-10-02 15:57:33 +02003691 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3692 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003693
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003694 # Configure
3695 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003696
Valerio Setti3f02bb72023-10-02 15:57:33 +02003697 # Start from full config
3698 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003699
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003700 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003701 scripts/config.py unset MBEDTLS_GCM_C
3702 scripts/config.py unset MBEDTLS_CCM_C
3703 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003704
Valerio Settia50b89e2023-11-08 15:58:47 +01003705 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3706 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003707
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003708 # Build
3709 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003710
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003711 helper_libtestdriver1_make_drivers "$loc_accel_list"
3712
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003713 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003714
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003715 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003716 not grep mbedtls_ccm library/ccm.o
3717 not grep mbedtls_gcm library/gcm.o
3718 not grep mbedtls_chachapoly library/chachapoly.o
3719
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003720 # Run the tests
3721 # -------------
3722
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003723 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3724 make test
3725}
3726
Valerio Settib680fc42023-10-13 09:29:37 +02003727# This is a common configuration function used in:
3728# - component_test_psa_crypto_config_accel_cipher_aead
3729# - component_test_psa_crypto_config_reference_cipher_aead
3730common_psa_crypto_config_accel_cipher_aead() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003731 # Start from the full config
3732 helper_libtestdriver1_adjust_config "full"
3733
Valerio Settiec9b2582023-11-08 16:50:54 +01003734 # CIPHER_C is disabled in the accelerated test component so we disable
3735 # all the features that depend on it both in the accelerated and in the
3736 # reference components.
3737 scripts/config.py unset MBEDTLS_PKCS5_C
3738 scripts/config.py unset MBEDTLS_PKCS12_C
3739
Valerio Settib680fc42023-10-13 09:29:37 +02003740 scripts/config.py unset MBEDTLS_NIST_KW_C
3741}
3742
Valerio Settib6b301f2023-10-04 12:05:05 +02003743# The 2 following test components, i.e.
3744# - component_test_psa_crypto_config_accel_cipher_aead
3745# - component_test_psa_crypto_config_reference_cipher_aead
3746# are meant to be used together in analyze_outcomes.py script in order to test
3747# driver's coverage for ciphers and AEADs.
3748component_test_psa_crypto_config_accel_cipher_aead () {
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003749 msg "build: full config with accelerated cipher and AEAD"
Valerio Settib6b301f2023-10-04 12:05:05 +02003750
Valerio Settiad8b7f02023-10-25 12:39:50 +02003751 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 +01003752 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003753 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003754 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3755
3756 # Configure
3757 # ---------
3758
Valerio Settib680fc42023-10-13 09:29:37 +02003759 common_psa_crypto_config_accel_cipher_aead
Valerio Settib6b301f2023-10-04 12:05:05 +02003760
3761 # Disable the things that are being accelerated
3762 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3763 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3764 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3765 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3766 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3767 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3768 scripts/config.py unset MBEDTLS_GCM_C
3769 scripts/config.py unset MBEDTLS_CCM_C
3770 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003771 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003772 scripts/config.py unset MBEDTLS_DES_C
3773 scripts/config.py unset MBEDTLS_AES_C
3774 scripts/config.py unset MBEDTLS_ARIA_C
3775 scripts/config.py unset MBEDTLS_CHACHA20_C
3776 scripts/config.py unset MBEDTLS_CAMELLIA_C
3777
Valerio Settiec9b2582023-11-08 16:50:54 +01003778 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3779 # does not depend on it.
3780 scripts/config.py unset MBEDTLS_CIPHER_C
3781
Valerio Settib6b301f2023-10-04 12:05:05 +02003782 # Build
3783 # -----
3784
3785 helper_libtestdriver1_make_drivers "$loc_accel_list"
3786
3787 helper_libtestdriver1_make_main "$loc_accel_list"
3788
3789 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003790 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003791 not grep mbedtls_des library/des.o
3792 not grep mbedtls_aes library/aes.o
3793 not grep mbedtls_aria library/aria.o
3794 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003795 not grep mbedtls_ccm library/ccm.o
3796 not grep mbedtls_gcm library/gcm.o
3797 not grep mbedtls_chachapoly library/chachapoly.o
3798 not grep mbedtls_cmac library/cmac.o
3799
3800 # Run the tests
3801 # -------------
3802
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003803 msg "test: full config with accelerated cipher and AEAD"
Valerio Settib6b301f2023-10-04 12:05:05 +02003804 make test
Valerio Settif9414552023-11-09 10:43:20 +01003805
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003806 msg "ssl-opt: full config with accelerated cipher and AEAD"
Valerio Settif9414552023-11-09 10:43:20 +01003807 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003808
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003809 msg "compat.sh: full config with accelerated cipher and AEAD"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003810 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003811}
3812
3813component_test_psa_crypto_config_reference_cipher_aead () {
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003814 msg "build: full config with non-accelerated cipher and AEAD"
Valerio Settib680fc42023-10-13 09:29:37 +02003815 common_psa_crypto_config_accel_cipher_aead
Valerio Settib6b301f2023-10-04 12:05:05 +02003816
Valerio Settif9414552023-11-09 10:43:20 +01003817 make
3818
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003819 msg "test: full config with non-accelerated cipher and AEAD"
Valerio Settib6b301f2023-10-04 12:05:05 +02003820 make test
Valerio Settif9414552023-11-09 10:43:20 +01003821
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003822 msg "ssl-opt: full config with non-accelerated cipher and AEAD"
Valerio Settif9414552023-11-09 10:43:20 +01003823 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003824
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003825 msg "compat.sh: full config with non-accelerated cipher and AEAD"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003826 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003827}
3828
Gilles Peskine36dea152023-07-20 22:19:45 +02003829component_test_aead_chachapoly_disabled() {
3830 msg "build: full minus CHACHAPOLY"
John Durkopf4c4cb02020-10-28 20:09:55 -07003831 scripts/config.py full
John Durkop9814fa22020-11-04 12:28:15 -08003832 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02003833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
John Durkopf4c4cb02020-10-28 20:09:55 -07003834 make CC=gcc CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
John Durkop6ba40d12020-11-10 08:50:04 -08003835
Gilles Peskine36dea152023-07-20 22:19:45 +02003836 msg "test: full minus CHACHAPOLY"
3837 make test
3838}
3839
3840component_test_aead_only_ccm() {
3841 msg "build: full minus CHACHAPOLY and GCM"
3842 scripts/config.py full
3843 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
3844 scripts/config.py unset MBEDTLS_GCM_C
3845 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
3846 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
3847 make CC=gcc CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
3848
3849 msg "test: full minus CHACHAPOLY and GCM"
John Durkop9814fa22020-11-04 12:28:15 -08003850 make test
John Durkopf4c4cb02020-10-28 20:09:55 -07003851}
3852
Ronald Crone501d0e2023-07-10 08:31:19 +02003853component_test_ccm_aes_sha256() {
3854 msg "build: CCM + AES + SHA256 configuration"
3855
Ronald Cron7612d8c2023-07-20 10:03:54 +02003856 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02003857 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02003858
3859 make CC=gcc
3860
3861 msg "test: CCM + AES + SHA256 configuration"
3862 make test
3863}
3864
John Durkop9814fa22020-11-04 12:28:15 -08003865# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkopf4c4cb02020-10-28 20:09:55 -07003866component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003867 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07003868 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07003869 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003870 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07003871 scripts/config.py unset MBEDTLS_ECDH_C
3872 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3873 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
3874 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3875 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3876 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
3877 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
John Durkop6ba40d12020-11-10 08:50:04 -08003878 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07003879}
3880
John Durkop1b7ee052020-11-27 08:51:22 -08003881# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
3882component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003883 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkop1b7ee052020-11-27 08:51:22 -08003884 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003885 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003886 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003887 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3888 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3889}
3890
3891# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
3892component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003893 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkop1b7ee052020-11-27 08:51:22 -08003894 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003895 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003896 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003897 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01003898 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
3899 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003900 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3901 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3902}
3903
3904# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
3905component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003906 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003907 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003908 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003909 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003910 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3911 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3912 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3913 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3914 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3915 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3916 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003917 scripts/config.py unset MBEDTLS_LMS_C
3918 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003919 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3920 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3921}
3922
3923# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
3924component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003925 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003926 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003927 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003928 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003929 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3930 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3931 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3932 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3933 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3934 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3935 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003936 scripts/config.py unset MBEDTLS_LMS_C
3937 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003938 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3939 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3940}
3941
3942# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
3943component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003944 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003945 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003946 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003947 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003948 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3949 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3950 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3951 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3952 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3953 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3954 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003955 scripts/config.py unset MBEDTLS_LMS_C
3956 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003957 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3958 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3959}
3960
3961# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
3962component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003963 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003964 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003965 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003966 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003967 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3968 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3969 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3970 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3971 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3972 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08003973 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3974 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3975}
3976
3977# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
3978component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003979 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003980 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003981 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003982 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003983 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3984 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3985 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3986 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3987 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3988 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08003989 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3990 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3991}
3992
3993# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
3994component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003995 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003996 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003997 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003998 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003999 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4000 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4001 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4002 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4003 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4004 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004005 scripts/config.py unset MBEDTLS_LMS_C
4006 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004007 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
4008 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
4009}
4010
4011# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4012component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004013 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004014 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004015 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004016 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004017 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4018 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4019 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4020 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4021 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4022 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4023 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004024 scripts/config.py unset MBEDTLS_LMS_C
4025 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004026 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
4027 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
4028}
4029
John Durkopd0321952020-10-29 21:37:36 -07004030# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004031component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004032 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_CRYPT + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopd0321952020-10-29 21:37:36 -07004033 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004034 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004035 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004036 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4037 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4038 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4039 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004040 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
John Durkopbd069d32020-10-31 22:14:03 -07004041 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
4042}
4043
4044# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004045component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004046 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_SIGN + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004047 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004048 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004049 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004050 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4051 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4052 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4053 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004054 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
4055 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
4056}
4057
4058# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004059component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004060 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_OAEP + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004061 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004062 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004063 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004064 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4065 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4066 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4067 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004068 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
4069 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
4070}
4071
4072# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004073component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004074 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PSS + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004075 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004076 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004077 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004078 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4079 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4080 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4081 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004082 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
4083 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
4084}
4085
4086# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004087component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004088 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_xxx + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004089 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004090 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004091 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004092 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4093 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4094 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4095 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4096 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004097 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
4098 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
4099}
4100
4101# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004102component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004103 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004104 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004105 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004106 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004107 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4108 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004109 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
4110 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004111}
4112
Dave Rodgmanc164c072023-06-28 09:43:23 +01004113
Dave Rodgman904c5892023-06-28 17:36:02 +01004114support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004115 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004116}
4117
Dave Rodgman904c5892023-06-28 17:36:02 +01004118component_build_tfm_armcc() {
4119 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004120 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004121
Dave Rodgman88651c42023-06-29 12:35:51 +01004122 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004123 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 +01004124}
4125
4126component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004127 # Check that the TF-M configuration can build cleanly with various
4128 # warning flags enabled. We don't build or run tests, since the
4129 # TF-M configuration needs a TF-M platform. A tweaked version of
4130 # the configuration that works on mainstream platforms is in
4131 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004132 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004133
Dave Rodgman88651c42023-06-29 12:35:51 +01004134 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004135 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 +01004136
Dave Rodgman904c5892023-06-28 17:36:02 +01004137 msg "build: TF-M config, gcc native build"
4138 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004139 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 +01004140}
4141
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004142# Test that the given .o file builds with all (valid) combinations of the given options.
4143#
4144# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4145#
4146# The validator function is the name of a function to validate the combination of options.
4147# It may be "" if all combinations are valid.
4148# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004149# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004150build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004151 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004152 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004153 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004154 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004155 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004156
Dave Rodgman42436102023-10-03 15:47:05 +01004157 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004158 for opt in "${options[@]}"; do
4159 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004160 done
4161
4162 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004163 cd $(dirname ${file})
4164 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004165
Dave Rodgman920343a2023-10-01 18:41:09 +01004166 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004167 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 +01004168
Dave Rodgman42436102023-10-03 15:47:05 +01004169 # Extract the command generated by the Makefile to build the target file.
4170 # This ensures that we have any include paths, macro definitions, etc
4171 # that may be applied by make.
4172 # 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 +01004173 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004174
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004175 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004176 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004177
Dave Rodgman28e38d82023-10-04 11:50:30 +01004178 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004179 source_file=${file%.o}.c
4180
4181 targets=0
4182 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004183
Dave Rodgman28e38d82023-10-04 11:50:30 +01004184 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004185 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004186 # each bit of $i is used to determine if options[i] will be set or not
4187 target="t"
4188 clang_args=""
4189 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004190 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004191 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004192 clang_args="${clang_args} ${opt}"
4193 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004194 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004195 done
4196
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004197 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004198 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004199 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004200 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004201
Dave Rodgman28e38d82023-10-04 11:50:30 +01004202 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004203 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004204 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004205 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004206
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004207 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004208
Dave Rodgman920343a2023-10-01 18:41:09 +01004209 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004210 make -s -f ${makefile} build_test_config_combos
4211 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004212
4213 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004214 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004215}
4216
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004217validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004218 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4219 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004220 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004221 fi
4222 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4223 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004224 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004225 fi
4226 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004227 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004228}
4229
4230component_build_aes_variations() {
4231 # 18s - around 90ms per clang invocation on M1 Pro
4232 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004233 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004234 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004235
Yanray Wangbc29aef2023-11-06 11:08:17 +08004236 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004237 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004238
Dave Rodgman42436102023-10-03 15:47:05 +01004239 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004240 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4241 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4242 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4243 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004244
4245 cd "$MBEDTLS_ROOT_DIR"
4246 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4247
Yanray Wang42be1ba2023-11-23 14:28:47 +08004248 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004249 # manually set or unset those configurations to check
4250 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004251 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4252 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4253 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4254 scripts/config.py unset MBEDTLS_DES_C
4255 scripts/config.py unset MBEDTLS_NIST_KW_C
4256 build_test_config_combos library/aes.o validate_aes_config_variations \
4257 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4258 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4259 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4260 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004261}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004262
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004263component_test_no_platform () {
4264 # Full configuration build, without platform support, file IO and net sockets.
4265 # This should catch missing mbedtls_printf definitions, and by disabling file
4266 # IO, it should catch missing '#include <stdio.h>'
4267 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004268 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004269 scripts/config.py unset MBEDTLS_PLATFORM_C
4270 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004271 scripts/config.py unset MBEDTLS_FS_IO
4272 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004273 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004274 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004275 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004276 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004277 # to re-enable platform integration features otherwise disabled in C99 builds
4278 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Simon Butchercb587002017-01-06 16:14:44 +00004279 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
4280}
Gilles Peskine7c652162017-12-11 00:01:40 +01004281
4282component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004283 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004284 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4285 scripts/config.py full
4286 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004287 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4288 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4289 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4290 make
4291}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004292
Gilles Peskine8f073122018-11-27 15:58:47 +01004293component_build_no_ssl_srv () {
4294 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004295 scripts/config.py full
4296 scripts/config.py unset MBEDTLS_SSL_SRV_C
4297 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
4298}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004299
Gilles Peskine8f073122018-11-27 15:58:47 +01004300component_build_no_ssl_cli () {
4301 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004302 scripts/config.py full
4303 scripts/config.py unset MBEDTLS_SSL_CLI_C
4304 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
4305}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004306
Gilles Peskine8f073122018-11-27 15:58:47 +01004307component_build_no_sockets () {
4308 # Note, C99 compliance can also be tested with the sockets support disabled,
4309 # as that requires a POSIX platform (which isn't the same as C99).
4310 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004311 scripts/config.py full
4312 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4313 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4314 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4315}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004316
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004317component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004318 msg "build: default config with memory buffer allocator and backtrace enabled"
4319 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4320 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4321 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004322 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4323 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
4324 make
4325
4326 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4327 make test
4328}
4329
4330component_test_memory_buffer_allocator () {
4331 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004332 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4333 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004334 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004335 make
4336
4337 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4338 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004339
4340 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4341 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004342 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004343}
4344
Gilles Peskine8f073122018-11-27 15:58:47 +01004345component_test_no_max_fragment_length () {
4346 # Run max fragment length tests with MFL disabled
4347 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004348 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004349 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4350 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004351
Gilles Peskine8f073122018-11-27 15:58:47 +01004352 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004353 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004354}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004355
Hanno Becker545ced42019-02-19 11:10:48 +00004356component_test_asan_remove_peer_certificate () {
4357 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004358 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Hanno Becker545ced42019-02-19 11:10:48 +00004359 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4360 make
4361
4362 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4363 make test
4364
4365 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004366 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004367
4368 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004369 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004370
4371 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004372 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004373}
4374
Gilles Peskine8f073122018-11-27 15:58:47 +01004375component_test_no_max_fragment_length_small_ssl_out_content_len () {
4376 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004377 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4378 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4379 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Gilles Peskine8f073122018-11-27 15:58:47 +01004380 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4381 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004382
Gilles Peskine8f073122018-11-27 15:58:47 +01004383 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004384 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004385
4386 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004387 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004388}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004389
Darryl Greenaad82f92019-12-02 10:53:11 +00004390component_test_variable_ssl_in_out_buffer_len () {
4391 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4392 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
4393 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4394 make
4395
4396 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4397 make test
4398
4399 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004400 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004401
4402 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004403 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004404}
4405
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004406component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004407 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004408 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004409
4410 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4411 make
4412
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004413 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004414 make test
4415
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004416 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004417 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004418
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004419 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004420 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004421}
4422
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004423component_test_ssl_alloc_buffer_and_mfl () {
4424 msg "build: default config with memory buffer allocator and MFL extension"
4425 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4426 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4427 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4428 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4429 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004430 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004431 make
4432
4433 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4434 make test
4435
4436 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 +02004437 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004438}
4439
Gilles Peskine636c26a2020-03-04 20:46:15 +01004440component_test_when_no_ciphersuites_have_mac () {
4441 msg "build: when no ciphersuites have MAC"
4442 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004443 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004444 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004445 make
4446
4447 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4448 make test
4449
4450 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004451 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004452}
4453
Raoul Strackxa4e86142020-06-15 17:03:13 +02004454component_test_no_date_time () {
4455 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4456 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004457 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004458 make
4459
4460 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4461 make test
4462}
4463
Gilles Peskine8f073122018-11-27 15:58:47 +01004464component_test_platform_calloc_macro () {
4465 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004466 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4467 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4468 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Gilles Peskine8f073122018-11-27 15:58:47 +01004469 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4470 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004471
Gilles Peskine8f073122018-11-27 15:58:47 +01004472 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4473 make test
4474}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004475
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004476component_test_malloc_0_null () {
4477 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004478 scripts/config.py full
Gilles Peskinecf4fe582023-07-20 19:00:15 +02004479 make CC=gcc CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"$PWD/tests/configs/user-config-malloc-0-null.h\"' $ASAN_CFLAGS -O" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004480
4481 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4482 make test
4483
4484 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4485 # Just the calloc selftest. "make test" ran the others as part of the
4486 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004487 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004488
4489 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4490 # Run a subset of the tests. The choice is a balance between coverage
4491 # and time (including time indirectly wasted due to flaky tests).
4492 # The current choice is to skip tests whose description includes
4493 # "proxy", which is an approximation of skipping tests that use the
4494 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004495 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004496}
4497
Dave Rodgman6a08b682023-06-19 11:51:33 +01004498support_test_aesni() {
4499 # Check that gcc targets x86_64 (we can build AESNI), and check for
4500 # AESNI support on the host (we can run AESNI).
4501 #
4502 # The name of this function is possibly slightly misleading, but needs to align
4503 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004504 #
4505 # In principle 32-bit x86 can support AESNI, but our implementation does not
4506 # support 32-bit x86, so we check for x86-64.
4507 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004508 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4509 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004510 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004511}
4512
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004513component_test_aesni () { # ~ 60s
4514 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4515 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4516 #
4517 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4518 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4519 # exercise the plain C impl).
4520
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004521 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004522 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004523 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004524 scripts/config.py set MBEDTLS_HAVE_ASM
4525
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004526 # test the intrinsics implementation
4527 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004528 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004529 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004530 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004531 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004532
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004533 # test the asm implementation
4534 msg "AES tests, test assembly"
4535 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004536 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004537 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004538 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004539
4540 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004541 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004542 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004543 msg "AES tests, plain C"
4544 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004545 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004546 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004547 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004548 not grep -q "AES note: using AESNI" ./programs/test/selftest
4549 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004550
4551 # test the intrinsics implementation
4552 scripts/config.py set MBEDTLS_AESNI_C
4553 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4554 msg "AES tests, test AESNI only"
4555 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004556 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004557 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4558 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004559 grep -q "AES note: using AESNI" ./programs/test/selftest
4560 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004561}
4562
Jerry Yub6d39c22023-08-16 15:11:48 +08004563support_test_aesni_m32() {
4564 support_test_m32_o0 && (lscpu | grep -qw aes)
4565}
4566
4567component_test_aesni_m32 () { # ~ 60s
4568 # This tests are duplicated from component_test_aesni for i386 target
4569 #
4570 # AESNI intrinsic code supports i386 and assembly code does not support it.
4571
4572 msg "build: default config with different AES implementations"
4573 scripts/config.py set MBEDTLS_AESNI_C
4574 scripts/config.py set MBEDTLS_PADLOCK_C
4575 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4576 scripts/config.py set MBEDTLS_HAVE_ASM
4577
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004578 # test the intrinsics implementation with gcc
4579 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004580 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004581 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004582 # check that we built intrinsics - this should be used by default when supported by the compiler
4583 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4584 grep -q "AES note: using AESNI" ./programs/test/selftest
4585 grep -q "AES note: built-in implementation." ./programs/test/selftest
4586 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4587 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4588
4589 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004590 scripts/config.py unset MBEDTLS_PADLOCK_C
4591 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4592 msg "AES tests, test AESNI only"
4593 make clean
4594 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4595 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4596 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4597 grep -q "AES note: using AESNI" ./programs/test/selftest
4598 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4599 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4600 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4601}
4602
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004603support_test_aesni_m32_clang() {
4604 support_test_aesni_m32 && if command -v clang > /dev/null ; then
4605 # clang >= 4 is required to build with target attributes
4606 clang_ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
4607 [[ "${clang_ver}" -ge 4 ]]
4608 else
4609 # clang not available
4610 false
4611 fi
4612}
4613
4614component_test_aesni_m32_clang() {
4615
4616 scripts/config.py set MBEDTLS_AESNI_C
4617 scripts/config.py set MBEDTLS_PADLOCK_C
4618 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4619 scripts/config.py set MBEDTLS_HAVE_ASM
4620
4621 # test the intrinsics implementation with clang
4622 msg "AES tests, test intrinsics (clang)"
4623 make clean
4624 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4625 # check that we built intrinsics - this should be used by default when supported by the compiler
4626 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4627 grep -q "AES note: using AESNI" ./programs/test/selftest
4628 grep -q "AES note: built-in implementation." ./programs/test/selftest
4629 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4630 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4631}
4632
Jerry Yu193cbc02023-08-03 17:06:29 +08004633# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4634component_build_aes_aesce_armcc () {
4635 msg "Build: AESCE test on arm64 platform without plain C."
4636 scripts/config.py baremetal
4637
4638 # armc[56] don't support SHA-512 intrinsics
4639 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4640
4641 # Stop armclang warning about feature detection for A64_CRYPTO.
4642 # With this enabled, the library does build correctly under armclang,
4643 # but in baremetal builds (as tested here), feature detection is
4644 # unavailable, and the user is notified via a #warning. So enabling
4645 # this feature would prevent us from building with -Werror on
4646 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004647 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004648 scripts/config.py set MBEDTLS_HAVE_ASM
4649
4650 msg "AESCE, build with default configuration."
4651 scripts/config.py set MBEDTLS_AESCE_C
4652 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4653 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4654
4655 msg "AESCE, build AESCE only"
4656 scripts/config.py set MBEDTLS_AESCE_C
4657 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4658 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4659}
4660
Dave Rodgman0c584032023-10-08 12:26:54 +01004661support_build_aes_armce() {
4662 # clang >= 4 is required to build with AES extensions
4663 ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
Dave Rodgman48b965d2023-10-09 12:19:44 +01004664 [ "${ver}" -ge 11 ]
Dave Rodgman0c584032023-10-08 12:26:54 +01004665}
4666
4667component_build_aes_armce () {
4668 # Test variations of AES with Armv8 crypto extensions
4669 scripts/config.py set MBEDTLS_AESCE_C
4670 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4671
4672 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004673 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004674
4675 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4676 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4677
4678 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4679 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4680
Dave Rodgman5e419372023-10-23 15:30:20 +01004681 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004682
Dave Rodgman5e419372023-10-23 15:30:20 +01004683 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4684 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004685
Dave Rodgman5e419372023-10-23 15:30:20 +01004686 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4687 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004688
Dave Rodgman5e419372023-10-23 15:30:20 +01004689 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4690 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004691
4692 # test for presence of AES instructions
4693 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4694 msg "clang, test A32 crypto instructions built"
4695 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4696 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4697 msg "clang, test T32 crypto instructions built"
4698 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4699 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4700 msg "clang, test aarch64 crypto instructions built"
4701 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4702 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4703
4704 # test for absence of AES instructions
4705 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4706 scripts/config.py unset MBEDTLS_AESCE_C
4707 msg "clang, test A32 crypto instructions not built"
4708 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4709 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4710 msg "clang, test T32 crypto instructions not built"
4711 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4712 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4713 msg "clang, test aarch64 crypto instructions not built"
4714 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4715 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004716}
4717
Dave Rodgman9ed18532023-10-05 00:06:47 +01004718support_build_sha_armce() {
Dave Rodgmanf2ea08a2023-10-16 11:37:28 +01004719 if command -v clang > /dev/null ; then
Dave Rodgmand35b1882023-10-16 10:25:30 +01004720 # clang >= 4 is required to build with SHA extensions
4721 clang_ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
Dave Rodgmanab0cff52023-10-13 09:32:04 +01004722
Dave Rodgman66d55122023-10-23 15:12:32 +01004723 [[ "${clang_ver}" -ge 4 ]]
Dave Rodgmand35b1882023-10-16 10:25:30 +01004724 else
4725 # clang not available
4726 false
4727 fi
Dave Rodgman9ed18532023-10-05 00:06:47 +01004728}
4729
Dave Rodgmand9e80832023-10-04 17:17:46 +01004730component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004731 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004732
4733
4734 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004735 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004736 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4737 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4738 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4739 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4740 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004741
Dave Rodgmand9e80832023-10-04 17:17:46 +01004742
Dave Rodgman94a634d2023-10-10 12:59:29 +01004743 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004744 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004745 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4746 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4747 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004748
Dave Rodgman5b89c552023-10-10 14:59:02 +01004749 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004750 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4751 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4752 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004753
Dave Rodgmancd654002023-10-05 09:40:07 +01004754
Dave Rodgman94a634d2023-10-10 12:59:29 +01004755 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004756 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004757 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4758 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4759 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4760 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4761 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004762
Dave Rodgmancd654002023-10-05 09:40:07 +01004763
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004764 # examine the disassembly for presence of SHA instructions
4765 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4766 scripts/config.py set ${opt}
4767 msg "${opt} clang, test A32 crypto instructions built"
4768 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4769 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4770
4771 msg "${opt} clang, test T32 crypto instructions built"
4772 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4773 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4774
4775 msg "${opt} clang, test aarch64 crypto instructions built"
4776 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4777 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4778 scripts/config.py unset ${opt}
4779 done
4780
4781
4782 # examine the disassembly for absence of SHA instructions
4783 msg "clang, test A32 crypto instructions not built"
4784 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4785 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4786
4787 msg "clang, test T32 crypto instructions not built"
4788 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4789 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4790
4791 msg "clang, test aarch64 crypto instructions not built"
4792 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4793 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004794}
4795
Jerry Yuc935aa62023-08-03 17:08:27 +08004796# For timebeing, no VIA Padlock platform available.
4797component_build_aes_via_padlock () {
4798
4799 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004800 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004801 scripts/config.py set MBEDTLS_PADLOCK_C
4802 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4803 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O2" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004804 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004805
4806}
4807
4808support_build_aes_via_padlock_only () {
4809 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4810 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4811 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4812}
4813
Jerry Yu193cbc02023-08-03 17:06:29 +08004814support_build_aes_aesce_armcc () {
4815 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004816}
4817
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004818component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004819 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004820 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004821 scripts/config.py unset MBEDTLS_PADLOCK_C
4822
4823 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004824
Gilles Peskine8f073122018-11-27 15:58:47 +01004825 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4826 make test
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004827}
4828
Gilles Peskine8f073122018-11-27 15:58:47 +01004829component_test_no_ctr_drbg_aes_only_128_bit_keys () {
Hanno Becker83ebf782017-07-07 12:29:15 +01004830 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine8f073122018-11-27 15:58:47 +01004831 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4832 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4833 scripts/config.py unset MBEDTLS_PADLOCK_C
4834
Gilles Peskine592f5912019-10-07 18:49:32 +02004835 make CC=clang CFLAGS='-Werror -Wall -Wextra'
4836
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004837 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4838 make test
4839}
Gilles Peskine592f5912019-10-07 18:49:32 +02004840
4841component_test_aes_only_128_bit_keys_have_builtins () {
4842 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4843 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4844 scripts/config.py unset MBEDTLS_PADLOCK_C
4845 scripts/config.py unset MBEDTLS_AESNI_C
4846 scripts/config.py unset MBEDTLS_AESCE_C
4847
4848 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004849
4850 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4851 make test
Gilles Peskine592f5912019-10-07 18:49:32 +02004852
4853 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4854 programs/test/selftest
4855}
4856
4857component_test_aes_fewer_tables () {
4858 msg "build: default config with AES_FEWER_TABLES enabled"
4859 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4860 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004861
4862 msg "test: AES_FEWER_TABLES"
4863 make test
4864}
Gilles Peskine592f5912019-10-07 18:49:32 +02004865
4866component_test_aes_rom_tables () {
4867 msg "build: default config with AES_ROM_TABLES enabled"
4868 scripts/config.py set MBEDTLS_AES_ROM_TABLES
4869 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
4870
4871 msg "test: AES_ROM_TABLES"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004872 make test
4873}
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004874
Gilles Peskine004206c2019-10-21 17:11:33 +02004875component_test_aes_fewer_tables_and_rom_tables () {
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004876 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4877 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4878 scripts/config.py set MBEDTLS_AES_ROM_TABLES
4879 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
4880
Steven Cooremand57203d2020-07-16 20:28:59 +02004881 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
Ronald Cron32a432a2023-03-28 09:19:04 +02004882 make test
Steven Cooreman753f9732021-03-15 11:38:44 +01004883}
Steven Cooreman6801f082021-02-19 17:21:22 +01004884
Yanray Wang49cd4b52023-11-10 11:58:37 +08004885# helper for common_block_cipher_no_decrypt() which:
4886# - enable/disable the list of config options passed from -s/-u respectively.
4887# - build
4888# - test for tests_suite_xxx
4889# - selftest
4890#
4891# Usage: helper_block_cipher_no_decrypt_build_test
4892# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4893# Options: -s set_opts the list of config options to enable
4894# -u unset_opts the list of config options to disable
4895# -c cflags the list of options passed to CFLAGS
4896# -l ldflags the list of options passed to LDFLAGS
4897helper_block_cipher_no_decrypt_build_test () {
4898 while [ $# -gt 0 ]; do
4899 case "$1" in
4900 -s)
4901 shift; local set_opts="$1";;
4902 -u)
4903 shift; local unset_opts="$1";;
4904 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004905 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004906 -l)
4907 shift; local ldflags="$1";;
4908 esac
4909 shift
4910 done
4911 set_opts="${set_opts:-}"
4912 unset_opts="${unset_opts:-}"
4913 cflags="${cflags:-}"
4914 ldflags="${ldflags:-}"
4915
Yanray Wangb2d6e522023-11-13 16:57:47 +08004916 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4917 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004918
4919 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4920 make clean
4921 make CC=gcc CFLAGS="$cflags" LDFLAGS="$ldflags"
4922
4923 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4924 not grep mbedtls_aes_setkey_dec library/aes.o
4925 not grep mbedtls_aria_setkey_dec library/aria.o
4926 not grep mbedtls_camellia_setkey_dec library/camellia.o
4927 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4928 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004929 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4930 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004931
4932 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4933 make test
4934
4935 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4936 programs/test/selftest
4937}
4938
4939# This is a common configuration function used in:
4940# - component_test_block_cipher_no_decrypt_aesni_legacy()
4941# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4942# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4943# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4944# on x86.
4945common_block_cipher_no_decrypt () {
4946 # test AESNI intrinsics
4947 helper_block_cipher_no_decrypt_build_test \
4948 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004949 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004950
4951 # test AESNI assembly
4952 helper_block_cipher_no_decrypt_build_test \
4953 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004954 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004955
4956 # test AES C implementation
4957 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004958 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004959
4960 # test AESNI intrinsics for i386 target
4961 helper_block_cipher_no_decrypt_build_test \
4962 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004963 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004964 -l "-m32"
4965}
4966
Yanray Wang3ae11992023-11-13 17:32:09 +08004967# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4968# usage: 0: no PSA crypto configuration
4969# 1: use PSA crypto configuration
4970config_block_cipher_no_decrypt () {
4971 use_psa=$1
4972
Yanray Wang66111392023-10-31 18:54:54 +08004973 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004974 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4975 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004976 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004977 scripts/config.py unset MBEDTLS_NIST_KW_C
4978
Yanray Wang3ae11992023-11-13 17:32:09 +08004979 if [ "$use_psa" -eq 1 ]; then
4980 # Enable support for cryptographic mechanisms through the PSA API.
4981 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4982 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4983 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4984 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4985 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4986 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4987 fi
4988}
4989
4990component_test_block_cipher_no_decrypt_aesni () {
4991 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004992 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004993}
4994
Yanray Wangf1496402023-11-01 18:55:13 +08004995component_test_block_cipher_no_decrypt_aesni_use_psa () {
Yanray Wang3ae11992023-11-13 17:32:09 +08004996 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004997 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004998}
4999
Yanray Wang66111392023-10-31 18:54:54 +08005000support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005001 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005002}
5003
Yanray Wang66111392023-10-31 18:54:54 +08005004component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005005 scripts/config.py baremetal
5006
5007 # armc[56] don't support SHA-512 intrinsics
5008 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5009
5010 # Stop armclang warning about feature detection for A64_CRYPTO.
5011 # With this enabled, the library does build correctly under armclang,
5012 # but in baremetal builds (as tested here), feature detection is
5013 # unavailable, and the user is notified via a #warning. So enabling
5014 # this feature would prevent us from building with -Werror on
5015 # armclang. Tracked in #7198.
5016 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5017 scripts/config.py set MBEDTLS_HAVE_ASM
5018
Yanray Wang3ae11992023-11-13 17:32:09 +08005019 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005020
5021 # test AESCE baremetal build
5022 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005023 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005024 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005025
Yanray Wangef1b04d2023-09-08 11:09:26 +08005026 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5027 not grep mbedtls_aes_setkey_dec library/aes.o
5028 not grep mbedtls_aria_setkey_dec library/aria.o
5029 not grep mbedtls_camellia_setkey_dec library/camellia.o
5030 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5031 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005032 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005033 not grep mbedtls_aesce_inverse_key library/aesce.o
5034 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005035}
5036
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005037component_test_ctr_drbg_aes_256_sha_256 () {
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005038 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5039 scripts/config.py full
5040 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5041 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
5042 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5043 make
5044
5045 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5046 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005047}
5048
Gilles Peskine14c3c062018-01-29 21:25:12 +01005049component_test_ctr_drbg_aes_128_sha_512 () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005050 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5051 scripts/config.py full
5052 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5053 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5054 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01005055 make
5056
5057 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5058 make test
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005059}
5060
5061component_test_ctr_drbg_aes_128_sha_256 () {
5062 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5063 scripts/config.py full
5064 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5065 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5066 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
5067 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5068 make
5069
5070 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5071 make test
5072}
5073
5074component_test_se_default () {
5075 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5076 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01005077 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005078
Andrzej Kurek87615772019-04-19 15:03:58 -04005079 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine56c01612019-07-03 20:43:32 +02005080 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005081}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005082
Steven Cooremand57203d2020-07-16 20:28:59 +02005083component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005084 msg "build: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005085 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005086 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005087 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5088 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005089 loc_cflags="${loc_cflags} -I../tests/include -O2"
5090
5091 make CC=gcc CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005092
Gilles Peskine1997f302023-07-26 18:45:20 +02005093 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005094 make test
5095}
5096
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005097component_test_make_shared () {
5098 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005099 make SHARED=1 all check
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005100 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005101 programs/test/dlopen_demo.sh
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005102}
5103
Gilles Peskinecf740502019-07-03 20:43:05 +02005104component_test_cmake_shared () {
5105 msg "build/test: cmake shared" # ~ 2min
5106 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5107 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005108 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005109 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005110 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005111}
5112
Gilles Peskineec10bf12019-09-20 19:56:06 +02005113test_build_opt () {
5114 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005115 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005116 for opt in "$@"; do
5117 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskinee094a182020-04-14 20:08:41 +02005118 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005119 # We're confident enough in compilers to not run _all_ the tests,
5120 # but at least run the unit tests. In particular, runs with
5121 # optimizations use inline assembly whereas runs with -O0
5122 # skip inline assembly.
5123 make test # ~30s
5124 make clean
5125 done
5126}
5127
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005128# For FreeBSD we invoke the function by name so this condition is added
5129# to disable the existing test_clang_opt function for linux.
5130if [[ $(uname) != "Linux" ]]; then
5131 component_test_clang_opt () {
5132 scripts/config.py full
5133 test_build_opt 'full config' clang -O0 -Os -O2
5134 }
5135fi
5136
5137component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005138 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005139 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005140}
5141support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005142 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005143}
5144
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005145component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005146 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005147 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005148}
5149support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005150 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005151}
5152
5153component_test_gcc_latest_opt () {
5154 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005155 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005156}
5157support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005158 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005159}
5160
5161component_test_gcc_earliest_opt () {
5162 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005163 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005164}
5165support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005166 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005167}
5168
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005169component_build_mbedtls_config_file () {
5170 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005171 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005172 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
5173 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005174 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005175 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5176 make clean
5177
5178 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5179 # In the user config, disable one feature (for simplicity, pick a feature
5180 # that nothing else depends on).
5181 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5182 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
5183 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5184
5185 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005186}
5187
Gilles Peskine7d904e72022-04-07 21:59:14 +02005188component_build_psa_config_file () {
5189 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5190 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5191 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5192 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5193 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005194 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005195 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5196 make clean
5197
5198 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5199 # In the user config, disable one feature, which will reflect on the
5200 # mbedtls configuration so we can query it with query_compile_time_config.
5201 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5202 scripts/config.py unset MBEDTLS_CMAC_C
5203 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5204 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5205
5206 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005207}
5208
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005209component_build_psa_alt_headers () {
5210 msg "build: make with PSA alt headers" # ~20s
5211
5212 # Generate alternative versions of the substitutable headers with the
5213 # same content except different include guards.
5214 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5215
5216 # Build the library and some programs.
5217 # Don't build the fuzzers to avoid having to go through hoops to set
5218 # a correct include path for programs/fuzz/Makefile.
5219 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
5220 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\"'"
5221
5222 # Check that we're getting the alternative include guards and not the
5223 # original include guards.
5224 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5225 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5226 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5227 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5228}
5229
Gilles Peskine8f073122018-11-27 15:58:47 +01005230component_test_m32_o0 () {
Gilles Peskine77f05352021-10-07 19:27:16 +02005231 # Build without optimization, so as to use portable C code (in a 32-bit
5232 # build) and not the i386-specific inline assembly.
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005233 msg "build: i386, make, gcc -O0 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005234 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005235 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine8fd59422019-10-21 17:11:33 +02005236 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O0" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005237
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005238 msg "test: i386, make, gcc -O0 (ASan build)"
5239 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005240}
Gilles Peskine878cf602019-01-06 20:50:38 +00005241support_test_m32_o0 () {
5242 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005243 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005244 *) false;;
5245 esac
5246}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005247
Gilles Peskineff0aee02021-10-05 09:36:03 +02005248component_test_m32_o2 () {
5249 # Build with optimization, to use the i386 specific inline assembly
5250 # and go faster for tests.
5251 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005252 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005253 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskineff0aee02021-10-05 09:36:03 +02005254 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O2" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005255
Gilles Peskineff0aee02021-10-05 09:36:03 +02005256 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005257 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005258
Gilles Peskineff0aee02021-10-05 09:36:03 +02005259 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005260 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005261}
Gilles Peskinecf522222021-10-07 19:25:29 +02005262support_test_m32_o2 () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005263 support_test_m32_o0 "$@"
5264}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005265
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005266component_test_m32_everest () {
5267 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005268 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005269 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine8fd59422019-10-21 17:11:33 +02005270 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O2" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005271
5272 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5273 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005274
5275 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005276 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005277
5278 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5279 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005280 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005281}
5282support_test_m32_everest () {
5283 support_test_m32_o0 "$@"
5284}
5285
Gilles Peskine8f073122018-11-27 15:58:47 +01005286component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005287 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005288 scripts/config.py full
Gilles Peskine5d26e7c2019-06-07 14:50:09 +02005289 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005290
5291 msg "test: 64-bit ILP32, make, gcc"
5292 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005293}
Gilles Peskine878cf602019-01-06 20:50:38 +00005294support_test_mx32 () {
5295 case $(uname -m) in
5296 amd64|x86_64) true;;
5297 *) false;;
5298 esac
5299}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005300
Peter Kolbus60c6da22018-12-27 06:59:04 -06005301component_test_min_mpi_window_size () {
5302 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005303 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Peter Kolbus60c6da22018-12-27 06:59:04 -06005304 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5305 make
5306
5307 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5308 make test
5309}
5310
Gilles Peskine8f073122018-11-27 15:58:47 +01005311component_test_have_int32 () {
5312 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005313 scripts/config.py unset MBEDTLS_HAVE_ASM
5314 scripts/config.py unset MBEDTLS_AESNI_C
5315 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005316 scripts/config.py unset MBEDTLS_AESCE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01005317 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005318
Gilles Peskine8f073122018-11-27 15:58:47 +01005319 msg "test: gcc, force 32-bit bignum limbs"
5320 make test
5321}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005322
Gilles Peskine8f073122018-11-27 15:58:47 +01005323component_test_have_int64 () {
5324 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005325 scripts/config.py unset MBEDTLS_HAVE_ASM
5326 scripts/config.py unset MBEDTLS_AESNI_C
5327 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005328 scripts/config.py unset MBEDTLS_AESCE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01005329 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005330
Gilles Peskine8f073122018-11-27 15:58:47 +01005331 msg "test: gcc, force 64-bit bignum limbs"
5332 make test
5333}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005334
Gabor Mezeie256cc12023-07-26 17:28:48 +02005335component_test_have_int32_cmake_new_bignum () {
5336 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5337 scripts/config.py unset MBEDTLS_HAVE_ASM
5338 scripts/config.py unset MBEDTLS_AESNI_C
5339 scripts/config.py unset MBEDTLS_PADLOCK_C
5340 scripts/config.py unset MBEDTLS_AESCE_C
5341 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005342 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005343 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005344
5345 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5346 make test
5347}
5348
Gilles Peskine8f073122018-11-27 15:58:47 +01005349component_test_no_udbl_division () {
5350 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005351 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005352 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine8f073122018-11-27 15:58:47 +01005353 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005354
Gilles Peskine8f073122018-11-27 15:58:47 +01005355 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5356 make test
5357}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005358
Gilles Peskine8f073122018-11-27 15:58:47 +01005359component_test_no_64bit_multiplication () {
5360 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005361 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005362 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine8f073122018-11-27 15:58:47 +01005363 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005364
Gilles Peskine8f073122018-11-27 15:58:47 +01005365 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5366 make test
5367}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005368
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005369component_test_no_strings () {
5370 msg "build: no strings" # ~10s
5371 scripts/config.py full
5372 # Disable options that activate a large amount of string constants.
5373 scripts/config.py unset MBEDTLS_DEBUG_C
5374 scripts/config.py unset MBEDTLS_ERROR_C
5375 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5376 scripts/config.py unset MBEDTLS_VERSION_FEATURES
5377 make CFLAGS='-Werror -Os'
5378
5379 msg "test: no strings" # ~ 10s
5380 make test
5381}
5382
Hanno Beckerc5722d12020-10-09 11:10:42 +01005383component_test_no_x509_info () {
5384 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5385 scripts/config.pl full
5386 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5387 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskineff0aee02021-10-05 09:36:03 +02005388 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005389
5390 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5391 make test
5392
5393 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005394 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005395}
5396
Gilles Peskine8f073122018-11-27 15:58:47 +01005397component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005398 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005399 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005400 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 +02005401
Gilles Peskinee36fe812021-09-01 20:00:33 +02005402 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005403 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005404}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005405
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005406component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005407 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005408 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005409 # Build for a target platform that's close to what Debian uses
5410 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005411 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005412 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005413 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005414 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'
5415
Gilles Peskinee36fe812021-09-01 20:00:33 +02005416 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005417 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005418}
5419support_build_arm_linux_gnueabi_gcc_arm5vte () {
5420 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5421}
5422
5423component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005424 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005425 scripts/config.py baremetal
5426 # This is an imperfect substitute for
5427 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005428 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005429 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 +02005430
Gilles Peskinee36fe812021-09-01 20:00:33 +02005431 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005432 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005433}
5434
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005435component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005436 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5437 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005438 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 +02005439
Gilles Peskinee36fe812021-09-01 20:00:33 +02005440 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005441 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005442 for lib in library/*.a; do
5443 echo "$lib:"
5444 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5445 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005446}
5447
Gilles Peskine8f073122018-11-27 15:58:47 +01005448component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005449 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005450 scripts/config.py baremetal
5451 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005452 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 +01005453 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005454 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005455}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005456
Gilles Peskine8f073122018-11-27 15:58:47 +01005457component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005458 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005459 scripts/config.py baremetal
5460 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005461 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 +01005462 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005463 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005464}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005465
Dave Rodgman8c315f22023-06-02 10:26:24 -04005466component_build_arm_clang_thumb () {
5467 # ~ 30s
5468
5469 scripts/config.py baremetal
5470
5471 msg "build: clang thumb 2, make"
5472 make clean
5473 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5474
5475 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5476 msg "build: clang thumb 1 -O0, make"
5477 make clean
5478 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5479
5480 msg "build: clang thumb 1 -Os, make"
5481 make clean
5482 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5483}
5484
Gilles Peskine8f073122018-11-27 15:58:47 +01005485component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005486 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005487 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005488 # armc[56] don't support SHA-512 intrinsics
5489 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005490
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005491 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5492 scripts/config.py unset MBEDTLS_AESCE_C
5493
Dave Rodgman0fddf822023-03-02 15:32:12 +00005494 # Stop armclang warning about feature detection for A64_CRYPTO.
5495 # With this enabled, the library does build correctly under armclang,
5496 # but in baremetal builds (as tested here), feature detection is
5497 # unavailable, and the user is notified via a #warning. So enabling
5498 # this feature would prevent us from building with -Werror on
5499 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005500 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005501
Hanno Beckerf0762e92022-07-15 12:08:19 +01005502 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005503
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005504 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005505
5506 msg "size: ARM Compiler 5"
5507 "$ARMC5_FROMELF" -z library/*.o
5508
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005509 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005510
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005511 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005512 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005513
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005514 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005515 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5516
5517 # ARM Compiler 6 - Target ARMv7-M+DSP
5518 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005519
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005520 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005521 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005522
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005523 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005524 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005525
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005526 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5527 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5528
Dave Rodgman99318e62023-05-24 12:27:42 +01005529 # ARM Compiler 6 - Target Cortex-M0
5530 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005531
5532 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5533 #
5534 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5535 # that we have in our CI
5536 scripts/config.py set MBEDTLS_AESCE_C
5537 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005538}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005539
Pengyu Lvdf070032023-02-24 16:03:31 +08005540support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005541 armc5_cc="$ARMC5_BIN_DIR/armcc"
5542 armc6_cc="$ARMC6_BIN_DIR/armclang"
5543 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005544}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005545
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005546component_test_tls13_only () {
5547 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3, without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005548 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Jerry Yuda5af222021-12-24 18:45:45 +08005549 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5550
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005551 msg "test: TLS 1.3 only, all key exchange modes enabled"
5552 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005553
Ronald Cronc3f43b62022-10-17 17:35:32 +02005554 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5555 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005556}
5557
Ronald Cronc3f43b62022-10-17 17:35:32 +02005558component_test_tls13_only_psk () {
5559 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5560 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5561 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5562 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005563 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005564 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5565 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5566 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5567 scripts/config.py unset MBEDTLS_ECDSA_C
5568 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005569 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005570 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005571 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5572
Ronald Cronc3f43b62022-10-17 17:35:32 +02005573 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5574 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005575
Ronald Cronc3f43b62022-10-17 17:35:32 +02005576 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5577 tests/ssl-opt.sh
5578}
5579
5580component_test_tls13_only_ephemeral () {
5581 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5582 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5583 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005584 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005585 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5586
5587 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5588 cd tests; ./test_suite_ssl; cd ..
5589
5590 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5591 tests/ssl-opt.sh
5592}
5593
Przemek Stekiela01c2422023-06-13 10:46:48 +02005594component_test_tls13_only_ephemeral_ffdh () {
5595 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5596 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5597 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5598 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005599 scripts/config.py unset MBEDTLS_ECDH_C
5600
Przemek Stekiela01c2422023-06-13 10:46:48 +02005601 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5602
5603 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5604 cd tests; ./test_suite_ssl; cd ..
5605
5606 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5607 tests/ssl-opt.sh
5608}
5609
Ronald Cronc3f43b62022-10-17 17:35:32 +02005610component_test_tls13_only_psk_ephemeral () {
5611 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5612 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5613 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5614 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5615 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5616 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5617 scripts/config.py unset MBEDTLS_ECDSA_C
5618 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005619 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005620 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005621 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5622
5623 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5624 cd tests; ./test_suite_ssl; cd ..
5625
5626 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5627 tests/ssl-opt.sh
5628}
5629
Przemek Stekiela01c2422023-06-13 10:46:48 +02005630component_test_tls13_only_psk_ephemeral_ffdh () {
5631 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5632 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5633 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5634 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5635 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5636 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5637 scripts/config.py unset MBEDTLS_ECDSA_C
5638 scripts/config.py unset MBEDTLS_PKCS1_V21
5639 scripts/config.py unset MBEDTLS_PKCS7_C
5640 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005641 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005642 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5643
5644 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5645 cd tests; ./test_suite_ssl; cd ..
5646
5647 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5648 tests/ssl-opt.sh
5649}
5650
Ronald Cronc3f43b62022-10-17 17:35:32 +02005651component_test_tls13_only_psk_all () {
5652 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5653 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5654 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5655 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5656 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5657 scripts/config.py unset MBEDTLS_ECDSA_C
5658 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005659 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005660 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005661 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5662
5663 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5664 cd tests; ./test_suite_ssl; cd ..
5665
5666 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5667 tests/ssl-opt.sh
5668}
5669
5670component_test_tls13_only_ephemeral_all () {
5671 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5672 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005673 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005674 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5675
5676 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5677 cd tests; ./test_suite_ssl; cd ..
5678
5679 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5680 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005681}
5682
Ronald Cron6f135e12021-12-08 16:57:54 +01005683component_test_tls13 () {
5684 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5685 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005686 scripts/config.py set MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5687 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005688 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005689 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5690 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005691 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005692 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005693 msg "ssl-opt.sh (TLS 1.3)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005694 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005695}
5696
Ronald Cron6f135e12021-12-08 16:57:54 +01005697component_test_tls13_no_compatibility_mode () {
5698 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5699 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005700 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5701 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005702 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Hanno Beckera711f6e2020-05-04 12:03:51 +01005703 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5704 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005705 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005706 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005707 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005708 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005709}
5710
Jan Bruckner151f6422023-02-10 12:45:19 +01005711component_test_tls13_only_record_size_limit () {
5712 msg "build: TLS 1.3 only from default, record size limit extension enabled"
5713 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
5714 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5715
5716 msg "test_suite_ssl: TLS 1.3 only, record size limit extension enabled"
5717 cd tests; ./test_suite_ssl; cd ..
5718
5719 msg "ssl-opt.sh: (TLS 1.3 only, record size limit extension tests only)"
5720 # Both the server and the client will currently abort the handshake when they encounter the
5721 # record size limit extension. There is no way to prevent gnutls-cli from sending the extension
5722 # which makes all G_NEXT_CLI + P_SRV tests fail. Thus, run only the tests for the this extension.
5723 tests/ssl-opt.sh -f "Record Size Limit"
5724}
5725
Gilles Peskine8f073122018-11-27 15:58:47 +01005726component_build_mingw () {
5727 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005728 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 +00005729
Gilles Peskine8f073122018-11-27 15:58:47 +01005730 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005731 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 +01005732 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005733
Gilles Peskine8f073122018-11-27 15:58:47 +01005734 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005735 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
5736 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 +01005737 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005738
Pengyu Lv158eead2023-10-19 11:27:05 +08005739 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005740 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005741 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 +01005742 make WINDOWS_BUILD=1 clean
5743}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005744support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005745 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5746 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005747 *) true;;
5748 esac
5749}
Simon Butcher91aef332016-11-17 09:20:50 +00005750
Gilles Peskine8f073122018-11-27 15:58:47 +01005751component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005752 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005753 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005754 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5755 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005756
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005757 msg "test: main suites (MSan)" # ~ 10s
5758 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005759
Gilles Peskine6848d172023-11-02 19:58:03 +01005760 msg "test: metatests (MSan)"
5761 tests/scripts/run-metatests.sh any msan
5762
Gilles Peskine82b27272019-06-14 18:27:03 +02005763 msg "program demos (MSan)" # ~20s
5764 tests/scripts/run_demos.py
5765
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005766 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005767 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005768
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005769 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005770
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005771 if [ "$MEMORY" -gt 0 ]; then
5772 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005773 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005774 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005775}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005776
Bence Szépkúti0354d042023-12-06 16:14:37 +01005777component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005778 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005779 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005780 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5781 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005782
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005783 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005784 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005785
Gilles Peskine636c26a2020-03-04 20:46:15 +01005786 # Optional parts (slow; currently broken on OS X because programs don't
5787 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005788 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005789 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005790 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005791 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005792 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005793
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005794 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005795 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005796 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005797 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005798
5799 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005800 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005801 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005802 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005803}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005804
Bence Szépkúti0354d042023-12-06 16:14:37 +01005805component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005806 msg "build: Release, full (clang)"
5807 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5808 scripts/config.py full
5809 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5810 make
5811
5812 msg "test: main suites, Valgrind (full config)"
5813 make memcheck
5814}
5815
Paul Elliott62dc3922021-11-25 17:29:40 +00005816support_test_cmake_out_of_source () {
5817 distrib_id=""
5818 distrib_ver=""
5819 distrib_ver_minor=""
5820 distrib_ver_major=""
5821
5822 # Attempt to parse lsb-release to find out distribution and version. If not
5823 # found this should fail safe (test is supported).
5824 if [[ -f /etc/lsb-release ]]; then
5825
5826 while read -r lsb_line; do
5827 case "$lsb_line" in
5828 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5829 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5830 esac
5831 done < /etc/lsb-release
5832
5833 distrib_ver_major="${distrib_ver%%.*}"
5834 distrib_ver="${distrib_ver#*.}"
5835 distrib_ver_minor="${distrib_ver%%.*}"
5836 fi
5837
5838 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5839 # processor (as the CI does) can create a race condition whereby the build
5840 # fails to see a generated file, despite that file actually having been
5841 # generated. This problem appears to go away with 18.04 or newer, so make
5842 # the out of source tests unsupported on Ubuntu 16.04.
5843 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5844}
5845
Gilles Peskine8f073122018-11-27 15:58:47 +01005846component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005847 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005848 # generates
5849 make neat
5850
Gilles Peskine8f073122018-11-27 15:58:47 +01005851 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005852 MBEDTLS_ROOT_DIR="$PWD"
5853 mkdir "$OUT_OF_SOURCE_DIR"
5854 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005855 # Note: Explicitly generate files as these are turned off in releases
5856 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005857 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005858
Gilles Peskine8f073122018-11-27 15:58:47 +01005859 msg "test: cmake 'out-of-source' build"
5860 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005861 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005862 # Also ensure that there are no error messages such as
5863 # "No such file or directory", which would indicate that some required
5864 # file is missing (ssl-opt.sh tolerates the absence of some files so
5865 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005866 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005867 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005868 cat ssl-opt.err >&2
5869 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005870 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005871 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005872 cd "$MBEDTLS_ROOT_DIR"
5873 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005874}
Andres AGdc192212016-08-31 17:33:13 +01005875
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005876component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005877 # Remove existing generated files so that we use the ones CMake
5878 # generates
5879 make neat
5880
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005881 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005882 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005883 # Note: Explicitly generate files as these are turned off in releases
5884 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005885 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005886 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005887}
Gilles Peskinea3000992022-02-04 00:21:12 +01005888support_test_cmake_as_subdirectory () {
5889 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005890}
5891
Chris Kayd259e342021-03-25 16:03:25 +00005892component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005893 # Remove existing generated files so that we use the ones CMake
5894 # generates
5895 make neat
5896
Chris Kayd259e342021-03-25 16:03:25 +00005897 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005898 cd programs/test/cmake_package
5899 cmake .
5900 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005901 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005902}
Gilles Peskinea3000992022-02-04 00:21:12 +01005903support_test_cmake_as_package () {
5904 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005905}
5906
5907component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005908 # Remove existing generated files so that we use the ones CMake
5909 # generates
5910 make neat
5911
Chris Kayd259e342021-03-25 16:03:25 +00005912 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005913 cd programs/test/cmake_package_install
5914 cmake .
5915 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005916 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005917}
Gilles Peskinea3000992022-02-04 00:21:12 +01005918support_test_cmake_as_package_install () {
5919 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005920}
5921
David Horstmann20550e32023-01-12 14:17:01 +00005922component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005923 # Make a copy of config file to use for the in-tree test
5924 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005925
5926 MBEDTLS_ROOT_DIR="$PWD"
5927 mkdir "$OUT_OF_SOURCE_DIR"
5928 cd "$OUT_OF_SOURCE_DIR"
5929
David Horstmann969c1452023-01-31 10:34:44 +00005930 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005931 cmake "$MBEDTLS_ROOT_DIR"
5932 make
5933
5934 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5935 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005936 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005937 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5938 make
5939
5940 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5941 # In the user config, disable one feature (for simplicity, pick a feature
5942 # that nothing else depends on).
5943 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5944
5945 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5946 make
5947 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5948
5949 rm -f user_config.h full_config.h
5950
5951 cd "$MBEDTLS_ROOT_DIR"
5952 rm -rf "$OUT_OF_SOURCE_DIR"
5953
5954 # Now repeat the test for an in-tree build:
5955
David Horstmann969c1452023-01-31 10:34:44 +00005956 # Restore config for the in-tree test
5957 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005958
David Horstmann969c1452023-01-31 10:34:44 +00005959 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005960 cmake .
5961 make
5962
5963 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5964 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005965 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005966 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5967 make
5968
5969 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5970 # In the user config, disable one feature (for simplicity, pick a feature
5971 # that nothing else depends on).
5972 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5973
5974 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5975 make
5976 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5977
5978 rm -f user_config.h full_config.h
5979}
5980support_build_cmake_custom_config_file () {
5981 support_test_cmake_out_of_source
5982}
5983
5984
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005985component_build_zeroize_checks () {
5986 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5987
5988 scripts/config.py full
5989
5990 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Tom Cosgroveb2fafa52023-09-01 14:40:21 +01005991 make CC=gcc 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 +01005992}
5993
5994
Gilles Peskine8f073122018-11-27 15:58:47 +01005995component_test_zeroize () {
5996 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5997 # different combinations of compilers and optimization flags by using an
5998 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5999 # system in all cases that the script fails, so we must manually search the
6000 # output to check whether the pass string is present and no failure strings
6001 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006002
Gilles Peskine4976e822019-01-06 19:52:22 +00006003 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6004 # about a spurious message if Gdb tries and fails, so suppress that.
6005 gdb_disable_aslr=
6006 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6007 gdb_disable_aslr='set disable-randomization off'
6008 fi
6009
Gilles Peskine8f073122018-11-27 15:58:47 +01006010 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006011 for compiler in clang gcc; do
6012 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6013 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006014 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6015 grep "The buffer was correctly zeroized" test_zeroize.log
6016 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006017 rm -f test_zeroize.log
6018 make clean
6019 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006020 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006021}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006022
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006023component_test_psa_compliance () {
6024 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Bence Szépkútica9236b2021-10-25 19:29:07 +02006025 make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006026
6027 msg "unit test: test_psa_compliance.py"
6028 ./tests/scripts/test_psa_compliance.py
6029}
6030
6031support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006032 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006033 ver="$(cmake --version)"
6034 ver="${ver#cmake version }"
6035 ver_major="${ver%%.*}"
6036
6037 ver="${ver#*.}"
6038 ver_minor="${ver%%.*}"
6039
6040 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006041}
6042
Gilles Peskinec848d222022-12-09 12:23:35 +01006043component_check_code_style () {
6044 msg "Check C code style"
6045 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006046}
6047
Gilles Peskinec848d222022-12-09 12:23:35 +01006048support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006049 case $(uncrustify --version) in
6050 *0.75.1*) true;;
6051 *) false;;
6052 esac
6053}
6054
Gilles Peskine8f073122018-11-27 15:58:47 +01006055component_check_python_files () {
6056 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006057 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006058}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006059
Joe Subbianid614c0b2021-07-29 11:18:29 +01006060component_check_test_helpers () {
6061 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006062 # unittest writes out mundane stuff like number or tests run on stderr.
6063 # Our convention is to reserve stderr for actual errors, and write
6064 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006065 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006066
Joe Subbiania25ffab2021-08-06 09:41:27 +01006067 msg "unit test: translate_ciphers.py"
6068 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006069}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006070
Jerry Yud767cc42023-03-31 15:03:55 +08006071
Gilles Peskine192c72f2017-12-21 15:59:21 +01006072################################################################
6073#### Termination
6074################################################################
6075
Gilles Peskine8f073122018-11-27 15:58:47 +01006076post_report () {
6077 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006078 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006079
Gilles Peskine8f073122018-11-27 15:58:47 +01006080 final_report
6081}
6082
6083
6084
6085################################################################
6086#### Run all the things
6087################################################################
6088
Gilles Peskine5d996822020-03-28 21:09:21 +01006089# Function invoked by --error-test to test error reporting.
6090pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006091 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006092 if [ $KEEP_GOING -ne 0 ]; then
6093 echo "Expect three failing commands."
6094 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006095 # If the component doesn't run in a subshell, changing error_test_i to an
6096 # invalid integer will cause an error in the loop that runs this function.
6097 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006098 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006099 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006100 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006101 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006102 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006103 make unknown_target
6104 false "this should not be executed"
6105}
6106
Gilles Peskinee48351a2018-11-27 16:06:30 +01006107# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006108run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006109 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006110 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006111
6112 # Unconditionally create a seedfile that's sufficiently long.
6113 # Do this before each component, because a previous component may
6114 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006115 local dd_cmd
6116 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6117 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006118 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006119 esac
6120 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006121
Gilles Peskineec135542021-08-02 23:14:03 +02006122 # Run the component in a subshell, with error trapping and output
6123 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006124 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006125 # We want to keep running if the subshell fails, so 'set -e' must
6126 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006127 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006128 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006129 (
6130 if [ $QUIET -eq 1 ]; then
6131 # msg() will be silenced, so just print the component name here.
6132 echo "${current_component#component_}"
6133 exec >/dev/null
6134 fi
6135 if [ $KEEP_GOING -eq 1 ]; then
6136 # Keep "set -e" off, and run an ERR trap instead to record failures.
6137 set -E
6138 trap err_trap ERR
6139 fi
6140 # The next line is what runs the component
6141 "$@"
6142 if [ $KEEP_GOING -eq 1 ]; then
6143 trap - ERR
6144 exit $last_failure_status
6145 fi
6146 )
6147 component_status=$?
6148 if [ $KEEP_GOING -eq 1 ]; then
6149 set -e
6150 if [ $component_status -ne 0 ]; then
6151 failure_count=$((failure_count + 1))
6152 fi
6153 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006154
6155 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006156 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006157 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006158}
6159
6160# Preliminary setup
6161pre_check_environment
Tom Cosgrove730addc2023-06-09 14:20:18 +01006162pre_parse_command_line_for_dirs "$@"
Gilles Peskine8f073122018-11-27 15:58:47 +01006163pre_initialize_variables
6164pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006165
Gilles Peskine878cf602019-01-06 20:50:38 +00006166pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006167pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006168pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006169
Gilles Peskine878cf602019-01-06 20:50:38 +00006170build_status=0
6171if [ $KEEP_GOING -eq 1 ]; then
6172 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006173fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006174pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006175pre_print_configuration
6176pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006177cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006178if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006179 pre_generate_files
6180fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006181
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006182# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006183for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006184 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006185done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006186unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006187for component in $RUN_COMPONENTS; do
6188 run_component "component_$component"
6189done
Gilles Peskine8f073122018-11-27 15:58:47 +01006190
6191# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006192post_report