blob: fe3f59466f1d7763e1465ed9ce2142e7082ae80b [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
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000192 # if CC is not set, use clang by default (if present) to improve build times
193 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
194 export CC=$(type -p clang)
Dave Rodgman66cbc832023-12-18 18:34:50 +0000195 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000196
Gilles Peskine396853a2021-09-20 18:57:55 +0200197 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000198 export CTEST_OUTPUT_ON_FAILURE=1
199
Gilles Peskine8fd59422019-10-21 17:11:33 +0200200 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100201 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200202 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000203 # Normally, tests should use this compiler for ASAN testing
204 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400206 # Platform tests have an allocation that returns null
207 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400208 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400209
Gilles Peskine878cf602019-01-06 20:50:38 +0000210 # Gather the list of available components. These are the functions
211 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100212 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000213
214 # Exclude components that are not supported on this platform.
215 SUPPORTED_COMPONENTS=
216 for component in $ALL_COMPONENTS; do
217 case $(type "support_$component" 2>&1) in
218 *' function'*)
219 if ! support_$component; then continue; fi;;
220 esac
221 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
222 done
Gilles Peskine8f073122018-11-27 15:58:47 +0100223}
Andres AG38495a32016-07-12 16:54:33 +0100224
Gilles Peskinea28db922019-01-10 00:05:18 +0100225# Test whether the component $1 is included in the command line patterns.
226is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100227{
Gilles Peskine03af6782021-08-06 11:35:17 +0200228 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
229 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100230 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000231 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100232 set +f
233 case ${1#component_} in $pattern) return 0;; esac
234 done
235 set +f
236 return 1
237}
Andres AG7770ea82016-10-10 15:46:20 +0100238
Simon Butcher41eeccf2016-09-07 00:07:09 +0100239usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100240{
Gilles Peskine709346a2017-12-10 23:43:39 +0100241 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100242Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100243Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100244By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100245COMPONENT can be the name of a component or a shell wildcard pattern.
246
247Examples:
248 $0 "check_*"
249 Run all sanity checks.
250 $0 --no-armcc --except test_memsan
251 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100252
253Special options:
254 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000255 --list-all-components List all available test components and exit.
256 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100257
258General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200259 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100260 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100261 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100262 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200263 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200264 --arm-none-eabi-gcc-prefix=<string>
265 Prefix for a cross-compiler for arm-none-eabi
266 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200267 --arm-linux-gnueabi-gcc-prefix=<string>
268 Prefix for a cross-compiler for arm-linux-gnueabi
269 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100270 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200271 --restore First clean up the build tree, restoring backed up
272 files. Do not run any components unless they are
273 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100274 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200275 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100276 --except Exclude the COMPONENTs listed on the command line,
277 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200278 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100279 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100280 --no-force Refuse to overwrite modified files (default).
281 --no-keep-going Stop at the first error (default).
282 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800283 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100284 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200285 --outcome-file=<path> File where test outcomes are written (not done if
286 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100287 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200288 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100289 -s|--seed Integer seed value to use for this test run.
290
291Tool path options:
292 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
293 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100294 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
295 --clang-latest=<Clang_latest_path> Latest version of clang available
296 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
297 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100298 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
299 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100300 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100301 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100302EOF
SimonB2e23c822016-04-16 21:54:39 +0100303}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100304
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200305# Cleanup before/after running a component.
306# Remove built files as well as the cmake cache/config.
307# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100308cleanup()
309{
David Horstmann76a77382023-08-17 17:32:26 +0100310 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100311 command make clean
312 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200313
Gilles Peskine31b07e22018-03-21 12:15:06 +0100314 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000315 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100316 -iname CMakeFiles -exec rm -rf {} \+ -o \
317 \( -iname cmake_install.cmake -o \
318 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200319 -iname CMakeCache.txt -o \
320 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100321 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200322 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200323
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100324 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
325 rm -rf programs/test/cmake_subproject/build
326 rm -f programs/test/cmake_subproject/Makefile
327 rm -f programs/test/cmake_subproject/cmake_subproject
328
Chris Kayd259e342021-03-25 16:03:25 +0000329 # Remove any artifacts from the component_test_cmake_as_package test.
330 rm -rf programs/test/cmake_package/build
331 rm -f programs/test/cmake_package/Makefile
332 rm -f programs/test/cmake_package/cmake_package
333
334 # Remove any artifacts from the component_test_cmake_as_installed_package test.
335 rm -rf programs/test/cmake_package_install/build
336 rm -f programs/test/cmake_package_install/Makefile
337 rm -f programs/test/cmake_package_install/cmake_package_install
338
Gilles Peskinef83eb822020-03-30 20:11:39 +0200339 # Restore files that may have been clobbered by the job
340 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200341 if [[ -e "$x$backup_suffix" ]]; then
342 cp -p "$x$backup_suffix" "$x"
343 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200344 done
345}
John Durkopbd069d32020-10-31 22:14:03 -0700346
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200347# Final cleanup when this script exits (except when exiting on a failure
348# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200349final_cleanup () {
350 cleanup
351
352 for x in $files_to_back_up; do
353 rm -f "$x$backup_suffix"
354 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100355}
356
Gilles Peskine7c652162017-12-11 00:01:40 +0100357# Executed on exit. May be redefined depending on command line options.
358final_report () {
359 :
360}
361
362fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200363 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100364 final_report $1
365 trap - $1
366 kill -$1 $$
367}
368
369trap 'fatal_signal HUP' HUP
370trap 'fatal_signal INT' INT
371trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200372
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200373# Number of processors on this machine. Used as the default setting
374# for parallel make.
375all_sh_nproc ()
376{
377 {
378 nproc || # Linux
379 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
380 sysctl -n hw.ncpu || # FreeBSD
381 echo 1
382 } 2>/dev/null
383}
384
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100385msg()
386{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100387 if [ -n "${current_component:-}" ]; then
388 current_section="${current_component#component_}: $1"
389 else
390 current_section="$1"
391 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200392
393 if [ $QUIET -eq 1 ]; then
394 return
395 fi
396
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100397 echo ""
398 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100399 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000400 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100401 echo "******************************************************************"
402}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100403
Gilles Peskine8f073122018-11-27 15:58:47 +0100404armc6_build_test()
405{
406 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100407
Gilles Peskine18487f62020-04-30 23:11:54 +0200408 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800409 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100410 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000411 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200412
413 msg "size: ARM Compiler 6 ($FLAGS)"
414 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100415}
Andres AGa5cd9732016-10-17 15:23:10 +0100416
Andres AGd9eba4b2016-08-26 14:42:14 +0100417err_msg()
418{
419 echo "$1" >&2
420}
421
422check_tools()
423{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200424 for tool in "$@"; do
425 if ! `type "$tool" >/dev/null 2>&1`; then
426 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100427 exit 1
428 fi
429 done
430}
431
Tom Cosgrove730addc2023-06-09 14:20:18 +0100432pre_parse_command_line_for_dirs () {
433 # Make an early pass through the options given, so we can set directories
434 # for Arm compilers, before SUPPORTED_COMPONENTS is determined.
435 while [ $# -gt 0 ]; do
436 case "$1" in
437 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
438 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
439 esac
440 shift
441 done
442}
443
Gilles Peskine8f073122018-11-27 15:58:47 +0100444pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000445 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100446 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100447 error_test=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200448 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000449 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100450
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000451 # Note that legacy options are ignored instead of being omitted from this
452 # list of options, so invocations that worked with previous version of
453 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100454 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100455 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200456 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200457 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200458 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000459 --armcc) no_armcc=;;
Tom Cosgrove730addc2023-06-09 14:20:18 +0100460 --armc5-bin-dir) shift; ;; # assignment to ARMC5_BIN_DIR done in pre_parse_command_line_for_dirs
461 --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 +0100462 --clang-earliest) shift; CLANG_EARLIEST="$1";;
463 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100464 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000465 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100466 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100467 --gcc-earliest) shift; GCC_EARLIEST="$1";;
468 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100469 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200470 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
471 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100472 --gnutls-serv) shift; GNUTLS_SERV="$1";;
473 --help|-h) usage; exit;;
474 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000475 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
476 --list-components) printf '%s\n' $SUPPORTED_COMPONENTS; exit;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100477 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200478 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000479 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100480 --no-force) FORCE=0;;
481 --no-keep-going) KEEP_GOING=0;;
482 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200483 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100484 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200486 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200488 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100489 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200490 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200491 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100492 --seed|-s) shift; SEED="$1";;
493 -*)
494 echo >&2 "Unknown option: $1"
495 echo >&2 "Run $0 --help for usage."
496 exit 120
497 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000498 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100499 esac
500 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100501 done
SimonB2e23c822016-04-16 21:54:39 +0100502
Gilles Peskinea28db922019-01-10 00:05:18 +0100503 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200504 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000505 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100506 fi
507
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000508 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
509 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100510 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000511 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100512 fi
SimonB2e23c822016-04-16 21:54:39 +0100513
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200514 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100515 if [ $all_except -eq 0 ]; then
516 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200517 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
518 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200519 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100520 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200521 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200522 # If the requested name includes a wildcard character, don't
523 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100524 case $component in
525 *[*?\[]*) continue;;
526 esac
527 case " $SUPPORTED_COMPONENTS " in
528 *" $component "*) :;;
529 *)
530 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
531 unsupported=$((unsupported + 1));;
532 esac
533 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200534 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100535 if [ $unsupported -ne 0 ]; then
536 exit 2
537 fi
538 fi
539
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000540 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100541 RUN_COMPONENTS=
542 for component in $SUPPORTED_COMPONENTS; do
543 if is_component_included "$component"; [ $? -eq $all_except ]; then
544 RUN_COMPONENTS="$RUN_COMPONENTS $component"
545 fi
546 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000547
548 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000549 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100550}
SimonB2e23c822016-04-16 21:54:39 +0100551
Gilles Peskine8f073122018-11-27 15:58:47 +0100552pre_check_git () {
553 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100554 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100555 git checkout-index -f -q $CONFIG_H
556 cleanup
557 else
SimonB2e23c822016-04-16 21:54:39 +0100558
Gilles Peskine8f073122018-11-27 15:58:47 +0100559 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
560 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
561 echo "You can either delete this directory manually, or force the test by rerunning"
562 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
563 exit 1
564 fi
565
Ronald Cron7a93ac52023-07-20 09:49:12 +0200566 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100567 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 echo "You can either delete or preserve your work, or force the test by rerunning the"
569 echo "script as: $0 --force"
570 exit 1
571 fi
SimonB2e23c822016-04-16 21:54:39 +0100572 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500573}
574
Gilles Peskine568f53a2021-07-12 18:16:01 +0200575pre_restore_files () {
576 # If the makefiles have been generated by a framework such as cmake,
577 # restore them from git. If the makefiles look like modifications from
578 # the ones checked into git, take care not to modify them. Whatever
579 # this function leaves behind is what the script will restore before
580 # each component.
581 case "$(head -n1 Makefile)" in
582 *[Gg]enerated*)
583 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
584 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
585 ;;
586 esac
587}
588
Gilles Peskinef83eb822020-03-30 20:11:39 +0200589pre_back_up () {
590 for x in $files_to_back_up; do
591 cp -p "$x" "$x$backup_suffix"
592 done
593}
594
Gilles Peskine8f073122018-11-27 15:58:47 +0100595pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100596 failure_count=0 # Number of failed components
597 last_failure_status=0 # Last failure status in this component
598
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100599 # See err_trap
600 previous_failure_status=0
601 previous_failed_command=
602 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100603 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100604
Gilles Peskine7c652162017-12-11 00:01:40 +0100605 start_red=
606 end_color=
607 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100608 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100609 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
610 start_red=$(printf '\033[31m')
611 end_color=$(printf '\033[0m')
612 ;;
613 esac
614 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100615
616 # Keep a summary of failures in a file. We'll print it out at the end.
617 failure_summary_file=$PWD/all-sh-failures-$$.log
618 : >"$failure_summary_file"
619
620 # Whether it makes sense to keep a component going after the specified
621 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200622 # This function normally receives the failing simple command
623 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
624 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100625 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200626 # False positives result in running things that can't be expected to
627 # work. False negatives result in things not running after something else
628 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100629 can_keep_going_after_failure () {
630 case "$1" in
631 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200632 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100633 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200634 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
635 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
636 *make*check*) true;;
637 "grep "*) true;;
638 "[ "*) true;;
639 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100640 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100641 esac
642 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100643
644 # This function runs if there is any error in a component.
645 # It must either exit with a nonzero status, or set
646 # last_failure_status to a nonzero value.
647 err_trap () {
648 # Save $? (status of the failing command). This must be the very
649 # first thing, before $? is overridden.
650 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100651 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100652
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100653 if [[ $last_failure_status -eq $previous_failure_status &&
654 "$failed_command" == "$previous_failed_command" &&
655 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
656 then
657 # The same command failed twice in a row, but this time one level
658 # less deep in the function call stack. This happens when the last
659 # command of a function returns a nonzero status, and the function
660 # returns that same status. Ignore the second failure.
661 previous_failure_funcall_depth=${#FUNCNAME[@]}
662 return
663 fi
664 previous_failure_status=$last_failure_status
665 previous_failed_command=$failed_command
666 previous_failure_funcall_depth=${#FUNCNAME[@]}
667
Gilles Peskinece266c42020-03-28 18:50:43 +0100668 text="$current_section: $failed_command -> $last_failure_status"
669 echo "${start_red}^^^^$text^^^^${end_color}" >&2
670 echo "$text" >>"$failure_summary_file"
671
672 # If the command is fatal (configure or build command), stop this
673 # component. Otherwise (test command) keep the component running
674 # (run more tests from the same build).
675 if ! can_keep_going_after_failure "$failed_command"; then
676 exit $last_failure_status
677 fi
678 }
679
Gilles Peskine7c652162017-12-11 00:01:40 +0100680 final_report () {
681 if [ $failure_count -gt 0 ]; then
682 echo
683 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100684 echo "${start_red}FAILED: $failure_count components${end_color}"
685 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100686 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
687 elif [ -z "${1-}" ]; then
688 echo "SUCCESS :)"
689 fi
690 if [ -n "${1-}" ]; then
691 echo "Killed by SIG$1."
692 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100693 rm -f "$failure_summary_file"
694 if [ $failure_count -gt 0 ]; then
695 exit 1
696 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100697 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100698}
699
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200700# record_status() and if_build_succeeded() are kept temporarily for backward
701# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100702record_status () {
703 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100704}
Gilles Peskine7c652162017-12-11 00:01:40 +0100705if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100707}
708
Gilles Peskinea681c592020-03-28 21:27:40 +0100709# '! true' does not trigger the ERR trap. Arrange to trigger it, with
710# a reasonably informative error message (not just "$@").
711not () {
712 if "$@"; then
713 report_failed_command="! $*"
714 false
715 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200716 fi
717}
718
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200719pre_prepare_outcome_file () {
720 case "$MBEDTLS_TEST_OUTCOME_FILE" in
721 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
722 esac
723 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
724 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
725 fi
726}
727
Gilles Peskine8f073122018-11-27 15:58:47 +0100728pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200729 if [ $QUIET -eq 1 ]; then
730 return
731 fi
732
Gilles Peskine8f073122018-11-27 15:58:47 +0100733 msg "info: $0 configuration"
734 echo "MEMORY: $MEMORY"
735 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200736 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100737 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100738 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100739 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100740 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
741 echo "GNUTLS_CLI: $GNUTLS_CLI"
742 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100743 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
744 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
745}
Andres AG7770ea82016-10-10 15:46:20 +0100746
Andres AGd9eba4b2016-08-26 14:42:14 +0100747# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100748pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000749 # Build the list of variables to pass to output_env.sh.
750 set env
SimonB2e23c822016-04-16 21:54:39 +0100751
Gilles Peskine87964262019-01-06 22:40:00 +0000752 case " $RUN_COMPONENTS " in
753 # Require OpenSSL and GnuTLS if running any tests (as opposed to
754 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
755 # is a good enough approximation in practice.
756 *" test_"*)
757 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
758 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100759 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000760 export GNUTLS_CLI="$GNUTLS_CLI"
761 export GNUTLS_SERV="$GNUTLS_SERV"
762 # Avoid passing --seed flag in every call to ssl-opt.sh
763 if [ -n "${SEED-}" ]; then
764 export SEED
765 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200766 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000767 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200768 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
769 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000770 ;;
771 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200772
Gilles Peskine87964262019-01-06 22:40:00 +0000773 case " $RUN_COMPONENTS " in
774 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
775 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100776
Gilles Peskine87964262019-01-06 22:40:00 +0000777 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200778 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000779 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100780
Gilles Peskine87964262019-01-06 22:40:00 +0000781 case " $RUN_COMPONENTS " in
782 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
783 esac
784
785 case " $RUN_COMPONENTS " in
786 *" test_zeroize "*) check_tools "gdb";;
787 esac
788
789 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000790 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000791 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
792 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200793 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000794 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
795 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200796 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
797 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
798 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000799 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000800
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200801 # past this point, no call to check_tool, only printing output
802 if [ $QUIET -eq 1 ]; then
803 return
804 fi
805
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000806 msg "info: output_env.sh"
807 case $RUN_COMPONENTS in
808 *_armcc*)
809 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
810 *) set "$@" RUN_ARMCC=0;;
811 esac
812 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100813}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100814
Gilles Peskine1570b592021-04-22 01:10:12 +0200815pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200816 # since make doesn't have proper dependencies, remove any possibly outdate
817 # file that might be around before generating fresh ones
818 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200819 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200820 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200821 else
822 make generated_files
823 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200824}
825
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200826################################################################
827#### Helpers for components using libtestdriver1
828################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100829
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200830# How to use libtestdriver1
831# -------------------------
832#
833# 1. Define the list algorithms and key types to accelerate,
834# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
835# Examples:
836# - loc_accel_list="ALG_JPAKE"
837# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200838# 2. Make configurations changes for the driver and/or main libraries.
839# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
840# can be either "default" to start with the default config, or a name
841# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200842# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200843# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
844# These changes affect both the driver and the main libraries.
845# (Note: they need to have the same set of PSA_WANT symbols, as that
846# determines the ABI between them.)
847# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
848# main libraries. Typically, you want to disable the module(s) that are
849# being accelerated. You may need to also disable modules that depend
850# on them or options that are not supported with drivers.
851# 2d. On top of psa/crypto_config.h, the driver library uses its own config
852# file: tests/include/test/drivers/config_test_driver.h. You usually
853# don't need to edit it: using loc_extra_list (see below) is preferred.
854# However, when there's no PSA symbol for what you want to enable,
855# calling scripts/config.py on this file remains the only option.
856# 3. Build the driver library, then the main libraries, test, and programs.
857# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
858# need to enable more algorithms here, typically hash algorithms when
859# accelerating some signature algorithms (ECDSA, RSAv2). This is done
860# by passing a 2nd argument listing the extra algorithms.
861# Example:
862# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
863# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800864# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200865# additional arguments will be passed to make: this can be useful if
866# you don't want to build everything when iterating during development.
867# Example:
868# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
869# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200870
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200871# Adjust the configuration - for both libtestdriver1 and main library,
872# as they should have the same PSA_WANT macros.
873helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200874 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200875 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200876 if [ "$base_config" != "default" ]; then
877 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200878 fi
879
880 # Enable PSA-based config (necessary to use drivers)
881 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
882
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200883 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
884 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
885 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200886}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100887
Valerio Settib2fd6732023-08-15 17:10:47 +0200888# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200889# The function optionally accepts 1 parameter: a space-separated list of the
890# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200891helper_disable_builtin_curves() {
892 allowed_list="${1:-}"
893 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
894
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200895 for curve in $allowed_list; do
896 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200897 done
898}
899
900# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
901# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
902# in the following helpers.
903helper_get_psa_curve_list () {
904 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200905 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
906 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200907 done
908
909 echo "$loc_list"
910}
911
912# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200913# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200914# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200915helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200916 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200917 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200918 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 +0200919 # Skip DERIVE for elliptic keys since there is no driver dispatch for
920 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200921 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
922 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200923 fi
924 done
925
926 echo "$loc_list"
927}
928
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200929# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200930#
931# Parameters:
932# 1. a space-separated list of things to accelerate;
933# 2. optional: a space-separate list of things to also support.
934# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
935helper_libtestdriver1_make_drivers() {
936 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Dave Rodgman17127e92023-12-14 16:42:48 +0000937 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200938}
939
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200940# Build the main libraries, programs and tests,
941# linking to the drivers library (with ASan).
942#
943# Parameters:
944# 1. a space-separated list of things to accelerate;
945# *. remaining arguments if any are passed directly to make
946# (examples: lib, -C tests test_suite_xxx, etc.)
947# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
948helper_libtestdriver1_make_main() {
949 loc_accel_list=$1
950 shift
951
952 # we need flags both with and without the LIBTESTDRIVER1_ prefix
953 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
954 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Dave Rodgman17127e92023-12-14 16:42:48 +0000955 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200956}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100957
958################################################################
959#### Basic checks
960################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100961
962#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200963# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100964#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +0100965# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200966# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100967# 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 +0200968# time, so start with a GCC build).
969# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100970#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +0100971# Indicative running times are given for reference.
972
Gilles Peskine8f073122018-11-27 15:58:47 +0100973component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200974 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200975 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +0100976}
Janos Follathb72c6782016-07-19 14:54:17 +0100977
Gilles Peskine67debb62021-05-18 16:09:50 +0200978component_check_generated_files () {
979 msg "Check: check-generated-files, files generated with make" # 2s
980 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200981 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +0200982
983 msg "Check: check-generated-files -u, files present" # 2s
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 msg "Check: check-generated-files -u, files absent" # 2s
989 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200990 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +0200991 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200992 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +0200993
994 # This component ends with the generated files present in the source tree.
995 # This is necessary for subsequent components!
996}
997
Gilles Peskine8f073122018-11-27 15:58:47 +0100998component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200999 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001000 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001001}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001002
Gilles Peskine8f073122018-11-27 15:58:47 +01001003component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001004 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001005 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001006}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001007
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001008component_check_changelog () {
1009 msg "Check: changelog entries" # < 1s
1010 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001011 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001012 if [ -e ChangeLog.new ]; then
1013 # Show the diff for information. It isn't an error if the diff is
1014 # non-empty.
1015 diff -u ChangeLog ChangeLog.new || true
1016 rm ChangeLog.new
1017 fi
1018}
1019
Gilles Peskine8f073122018-11-27 15:58:47 +01001020component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001021 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001022 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001023}
Darryl Greena07039c2018-03-13 16:48:16 +00001024
Gilles Peskine895868b2019-09-19 21:30:05 +02001025component_check_test_cases () {
1026 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001027 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001028 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001029 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001030 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001031 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001032 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001033 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001034}
1035
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001036component_check_test_dependencies () {
1037 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001038 # The purpose of this component is to catch unjustified dependencies on
1039 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1040 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1041 # MBEDTLS_PSA_xxx).
1042 #
1043 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1044 # this component is meant to catch. However a few of them are justified,
1045 # mostly by the absence of a PSA equivalent, so this component includes a
1046 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001047
1048 found="check-test-deps-found-$$"
1049 expected="check-test-deps-expected-$$"
1050
1051 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001052 grep 'depends_on' \
1053 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001054 grep -Eo '!?MBEDTLS_[^: ]*' |
1055 grep -v MBEDTLS_PSA_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001056 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001057
Yanray Wang18040ed2023-11-23 21:29:56 +08001058 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001059 rm -f $expected
1060 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1061 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001062 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1063 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001064 # This is used by import_rsa_made_up() in test_suite_psa_crypto in order
1065 # to build a fake RSA key of the wanted size based on
1066 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1067 # the test code and that's probably the most convenient way of achieving
1068 # the test's goal.
1069 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1070 # No PSA equivalent - we should probably have one in the future.
1071 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1072 # No PSA equivalent - needed by some init tests
1073 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
1074 # Used by two tests that are about an extension to the PSA standard;
1075 # as such, no PSA equivalent.
1076 echo "MBEDTLS_PEM_PARSE_C" >> $expected
1077
1078 # Compare reality with expectation.
1079 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001080 #
1081 # The output should be empty. When it's not:
1082 # - Each '+' line is a macro that was found but not expected. You want to
1083 # find where that macro occurs, and either replace it with PSA macros, or
1084 # add it to the exceptions list above with a justification.
1085 # - Each '-' line is a macro that was expected but not found; it means the
1086 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001087 diff -U0 $expected $found
1088
1089 rm $found $expected
1090}
1091
Gilles Peskine8f073122018-11-27 15:58:47 +01001092component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001093 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001094 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001095}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001096
Gilles Peskine192c72f2017-12-21 15:59:21 +01001097
Gilles Peskine636c26a2020-03-04 20:46:15 +01001098
Gilles Peskine192c72f2017-12-21 15:59:21 +01001099################################################################
1100#### Build and test many configurations and targets
1101################################################################
1102
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001103component_test_default_out_of_box () {
1104 msg "build: make, default config (out-of-box)" # ~1min
1105 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001106 # Disable fancy stuff
1107 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001108
1109 msg "test: main suites make, default config (out-of-box)" # ~10s
1110 make test
1111
1112 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001113 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001114
1115 msg "program demos: make, default config (out-of-box)" # ~10s
1116 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001117}
1118
Gilles Peskine8f073122018-11-27 15:58:47 +01001119component_test_default_cmake_gcc_asan () {
1120 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001121 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1122 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001123
Gilles Peskine8f073122018-11-27 15:58:47 +01001124 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1125 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001126
Gilles Peskine82b27272019-06-14 18:27:03 +02001127 msg "program demos (ASan build)" # ~10s
1128 tests/scripts/run_demos.py
1129
Gilles Peskine97bea012020-04-23 23:37:45 +02001130 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001131 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001132
Gilles Peskine6848d172023-11-02 19:58:03 +01001133 msg "test: metatests (GCC, ASan build)"
1134 tests/scripts/run-metatests.sh any asan
1135
Gilles Peskine8f073122018-11-27 15:58:47 +01001136 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001137 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001138
Gilles Peskine8f073122018-11-27 15:58:47 +01001139 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001140 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001141
1142 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001143 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001144}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001145
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001146component_test_default_cmake_gcc_asan_new_bignum () {
1147 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001148 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001149 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001150 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001151
1152 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1153 make test
1154
1155 msg "test: selftest (ASan build)" # ~ 10s
1156 programs/test/selftest
1157
1158 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1159 tests/ssl-opt.sh
1160
1161 msg "test: compat.sh (ASan build)" # ~ 6 min
1162 tests/compat.sh
1163
1164 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1165 tests/context-info.sh
1166}
1167
Hanno Becker01635512019-02-26 14:27:09 +00001168component_test_full_cmake_gcc_asan () {
1169 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001170 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001171 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1172 make
1173
1174 msg "test: main suites (inc. selftests) (full config, ASan build)"
1175 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001176
Gilles Peskine97bea012020-04-23 23:37:45 +02001177 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001178 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001179
Gilles Peskine636c26a2020-03-04 20:46:15 +01001180 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001181 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001182
1183 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001184 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001185
1186 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001187 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001188}
1189
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001190
1191component_test_full_cmake_gcc_asan_new_bignum () {
1192 msg "build: full config, cmake, gcc, ASan"
1193 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001194 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001195 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001196 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001197
1198 msg "test: main suites (inc. selftests) (full config, ASan build)"
1199 make test
1200
1201 msg "test: selftest (ASan build)" # ~ 10s
1202 programs/test/selftest
1203
1204 msg "test: ssl-opt.sh (full config, ASan build)"
1205 tests/ssl-opt.sh
1206
1207 msg "test: compat.sh (full config, ASan build)"
1208 tests/compat.sh
1209
1210 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1211 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001212}
1213
Ronald Cronc3623db2020-10-29 10:51:32 +01001214component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001215 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001216 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001217 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1218 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1219 make
1220
1221 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1222 make test
1223}
1224
Gilles Peskinea3548672021-06-17 11:37:52 +02001225# check_renamed_symbols HEADER LIB
1226# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1227# name is LIB.
1228check_renamed_symbols () {
1229 ! nm "$2" | sed 's/.* //' |
1230 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1231}
1232
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001233component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001234 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001235 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001236 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1237 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1238 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1239 # We can only compile, not link, since our test and sample programs
1240 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1241 # is active.
1242 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001243
1244 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1245 # version is not present.
1246 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001247 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001248}
1249
Ronald Cron336678b2021-01-28 17:54:24 +01001250component_test_psa_crypto_client () {
1251 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1252 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1253 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1254 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001255 scripts/config.py unset MBEDTLS_LMS_C
1256 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Ronald Cron336678b2021-01-28 17:54:24 +01001257 make
1258
1259 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1260 make test
1261}
1262
Jaeden Amero424fa932021-05-14 08:34:32 +01001263component_test_psa_crypto_rsa_no_genprime() {
1264 msg "build: default config minus MBEDTLS_GENPRIME"
1265 scripts/config.py unset MBEDTLS_GENPRIME
1266 make
1267
1268 msg "test: default config minus MBEDTLS_GENPRIME"
1269 make test
1270}
1271
Gilles Peskine782f4112018-11-27 16:11:09 +01001272component_test_ref_configs () {
1273 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001274 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1275 # want to re-generate generated files that depend on it, quite correctly.
1276 # However this doesn't work as the generation script expects a specific
1277 # format for mbedtls_config.h, which the other files don't follow. Also,
1278 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001279 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001280 # whether they're on or off. So, disable cmake's (over-sensitive here)
1281 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001282 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001283 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001284 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001285}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001286
Gilles Peskine8f073122018-11-27 15:58:47 +01001287component_test_no_renegotiation () {
1288 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001289 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001290 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001291 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001292
Gilles Peskine8f073122018-11-27 15:58:47 +01001293 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1294 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001295
Gilles Peskine8f073122018-11-27 15:58:47 +01001296 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001297 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001298}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001299
Gilles Peskine636c26a2020-03-04 20:46:15 +01001300component_test_no_pem_no_fs () {
1301 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1302 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1303 scripts/config.py unset MBEDTLS_FS_IO
1304 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1305 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001306 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001307 make
1308
1309 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1310 make test
1311
1312 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001313 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001314}
1315
Gilles Peskine8f073122018-11-27 15:58:47 +01001316component_test_rsa_no_crt () {
1317 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001318 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001319 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001320 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001321
Gilles Peskine8f073122018-11-27 15:58:47 +01001322 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1323 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001324
Gilles Peskine8f073122018-11-27 15:58:47 +01001325 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001326 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001327
Gilles Peskine8f073122018-11-27 15:58:47 +01001328 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001329 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001330
1331 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001332 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001333}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001334
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001335component_test_no_ctr_drbg_classic () {
1336 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001337 scripts/config.py full
1338 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001339 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001340 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001341
Dave Rodgman17127e92023-12-14 16:42:48 +00001342 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001343 make
1344
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001345 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001346 make test
1347
Gilles Peskineba749042021-01-13 20:02:03 +01001348 # In this configuration, the TLS test programs use HMAC_DRBG.
1349 # The SSL tests are slow, so run a small subset, just enough to get
1350 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001351 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001352 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001353
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001354 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001355 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001356}
1357
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001358component_test_no_ctr_drbg_use_psa () {
1359 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001360 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001361 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1362 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001363
Dave Rodgman17127e92023-12-14 16:42:48 +00001364 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001365 make
1366
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001367 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1368 make test
1369
1370 # In this configuration, the TLS test programs use HMAC_DRBG.
1371 # The SSL tests are slow, so run a small subset, just enough to get
1372 # confidence that the SSL code copes with HMAC_DRBG.
1373 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001374 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001375
1376 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001377 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001378}
1379
1380component_test_no_hmac_drbg_classic () {
1381 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1382 scripts/config.py full
1383 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1384 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1385 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001386 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001387
Dave Rodgman17127e92023-12-14 16:42:48 +00001388 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001389 make
1390
1391 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001392 make test
1393
Gilles Peskinea2224342020-11-19 22:14:34 +01001394 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1395 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1396 # instead.
1397 # Test SSL with non-deterministic ECDSA. Only test features that
1398 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001399 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001400 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001401
1402 # To save time, only test one protocol version, since this part of
1403 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001404 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001405 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001406}
1407
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001408component_test_no_hmac_drbg_use_psa () {
1409 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1410 scripts/config.py full
1411 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1412 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1413 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1414
Dave Rodgman17127e92023-12-14 16:42:48 +00001415 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001416 make
1417
1418 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1419 make test
1420
1421 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1422 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1423 # instead.
1424 # Test SSL with non-deterministic ECDSA. Only test features that
1425 # might be affected by how ECDSA signature is performed.
1426 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001427 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001428
1429 # To save time, only test one protocol version, since this part of
1430 # the protocol is identical in (D)TLS up to 1.2.
1431 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001432 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001433}
1434
1435component_test_psa_external_rng_no_drbg_classic () {
1436 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1437 scripts/config.py full
1438 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001439 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001440 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001441 scripts/config.py unset MBEDTLS_ENTROPY_C
1442 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1443 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001444 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1445 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1446 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001447 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1448 # the SSL test programs don't have an RNG and can't work. Explicitly
1449 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Dave Rodgman17127e92023-12-14 16:42:48 +00001450 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001451
1452 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1453 make test
1454
Gilles Peskine8eb29432021-02-03 20:07:11 +01001455 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001456 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001457}
1458
1459component_test_psa_external_rng_no_drbg_use_psa () {
1460 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001461 scripts/config.py full
1462 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001463 scripts/config.py unset MBEDTLS_ENTROPY_C
1464 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1465 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001466 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1467 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1468 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Dave Rodgman17127e92023-12-14 16:42:48 +00001469 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001470
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001471 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001472 make test
1473
Gilles Peskine8eb29432021-02-03 20:07:11 +01001474 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001475 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001476}
1477
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001478component_test_psa_external_rng_use_psa_crypto () {
1479 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1480 scripts/config.py full
1481 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1482 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1483 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Dave Rodgman17127e92023-12-14 16:42:48 +00001484 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001485
1486 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1487 make test
1488
1489 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1490 tests/ssl-opt.sh -f 'Default\|opaque'
1491}
1492
Gilles Peskine801c4332023-04-28 21:04:28 +02001493component_test_psa_inject_entropy () {
1494 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1495 scripts/config.py full
1496 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1497 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1498 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1499 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1500 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1501 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Dave Rodgman17127e92023-12-14 16:42:48 +00001502 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine801c4332023-04-28 21:04:28 +02001503
1504 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1505 make test
1506}
1507
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001508component_test_sw_inet_pton () {
1509 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1510
1511 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1512 scripts/config.py set MBEDTLS_TEST_HOOKS
1513 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1514
1515 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1516 make test
1517}
1518
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001519component_test_crypto_full_md_light_only () {
1520 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001521 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001522 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001523 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001524 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001525 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001526 scripts/config.py unset MBEDTLS_HKDF_C
1527 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001528 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001529 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001530 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001531 # Disable things that would auto-enable MD_C
1532 scripts/config.py unset MBEDTLS_PKCS5_C
1533
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001534 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1535 # which we haven't disabled, so no need to explicitly enable it.
Dave Rodgman17127e92023-12-14 16:42:48 +00001536 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001537
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001538 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001539 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001540 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001541
1542 msg "test: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001543 make test
1544}
1545
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001546component_test_full_no_cipher () {
Valerio Settidf17a102023-10-23 14:14:19 +02001547 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001548 scripts/config.py full
1549 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001550 # Don't pull in cipher via PSA mechanisms
1551 # (currently ignored anyway because we completely disable PSA)
1552 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001553 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001554 scripts/config.py unset MBEDTLS_CMAC_C
1555 scripts/config.py unset MBEDTLS_NIST_KW_C
1556 scripts/config.py unset MBEDTLS_PKCS12_C
1557 scripts/config.py unset MBEDTLS_PKCS5_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001558 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1559 scripts/config.py unset MBEDTLS_SSL_TLS_C
1560 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001561 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001562 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1563 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001564 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001565 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001566 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001567
Valerio Settidf17a102023-10-23 14:14:19 +02001568 msg "test: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001569 make test
1570}
1571
Valerio Setti7e710e82023-08-25 09:14:15 +02001572# This is a common configurator and test function that is used in:
1573# - component_test_full_no_cipher_with_crypto
1574# - component_test_full_no_cipher_with_crypto_config
1575# It accepts 2 input parameters:
1576# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1577# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001578common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001579 USE_CRYPTO_CONFIG="$1"
1580 COMPONENT_DESCRIPTION="$2"
1581
1582 msg "build: $COMPONENT_DESCRIPTION"
1583
1584 scripts/config.py full
1585 scripts/config.py unset MBEDTLS_CIPHER_C
1586
1587 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001588 # The built-in implementation of the following algs/key-types depends
1589 # on CIPHER_C so we disable them.
1590 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1591 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001592 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001593 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1594 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1595 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1596 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1597 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1598 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1599 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1600 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001601 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001602 else
1603 # Don't pull in cipher via PSA mechanisms
1604 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001605 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1606 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1607 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti287f6d12023-10-24 14:12:59 +02001608 scripts/config.py unset MBEDTLS_DES_C
Valerio Setti287f6d12023-10-24 14:12:59 +02001609 # Dependencies on AES_C
1610 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001611 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001612 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001613 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001614 scripts/config.py unset MBEDTLS_NIST_KW_C
1615 scripts/config.py unset MBEDTLS_PKCS12_C
1616 scripts/config.py unset MBEDTLS_PKCS5_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001617
Gilles Peskine636c26a2020-03-04 20:46:15 +01001618 make
1619
Valerio Setti7e710e82023-08-25 09:14:15 +02001620 # Ensure that CIPHER_C was not re-enabled
1621 not grep mbedtls_cipher_init library/cipher.o
1622
1623 msg "test: $COMPONENT_DESCRIPTION"
1624 make test
1625}
1626
1627component_test_full_no_cipher_with_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001628 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001629}
1630
1631component_test_full_no_cipher_with_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001632 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001633}
1634
Valerio Settibdfecb62023-11-07 15:37:20 +01001635component_test_full_no_ccm() {
1636 msg "build: full no PSA_WANT_ALG_CCM"
1637
1638 # Full config enables:
1639 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1640 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1641 scripts/config.py full
1642
1643 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1644 # enabled, but not used from TLS since USE_PSA is set.
1645 # This is helpful to ensure that TLS tests below have proper dependencies.
1646 #
1647 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1648 # PSA_WANT_ALG_CCM to be re-enabled.
1649 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1650
Valerio Settiff2b06a2023-11-08 12:35:36 +01001651 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001652
1653 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001654 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001655}
1656
1657component_test_full_no_ccm_star_no_tag() {
1658 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1659
1660 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1661 scripts/config.py full
1662
1663 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1664 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1665 # This basically disables all unauthenticated ciphers on the PSA side, while
1666 # keeping AEADs enabled.
1667 #
1668 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1669 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1670 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1671 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1672 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1673 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1674 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1675 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1676 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1677 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1678
Valerio Settiff2b06a2023-11-08 12:35:36 +01001679 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001680
1681 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001682 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001683
1684 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001685 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001686}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001687
Valerio Settie1655b82023-01-03 15:35:25 +01001688component_test_full_no_bignum () {
1689 msg "build: full minus bignum"
1690 scripts/config.py full
1691 scripts/config.py unset MBEDTLS_BIGNUM_C
1692 # Direct dependencies of bignum
1693 scripts/config.py unset MBEDTLS_ECP_C
1694 scripts/config.py unset MBEDTLS_RSA_C
1695 scripts/config.py unset MBEDTLS_DHM_C
1696 # Direct dependencies of ECP
1697 scripts/config.py unset MBEDTLS_ECDH_C
1698 scripts/config.py unset MBEDTLS_ECDSA_C
1699 scripts/config.py unset MBEDTLS_ECJPAKE_C
1700 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001701 # Disable what auto-enables ECP_LIGHT
1702 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1703 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001704 # Indirect dependencies of ECP
1705 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1706 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1707 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1708 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1709 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1710 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1711 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1712 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1713 # Direct dependencies of DHM
1714 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1715 # Direct dependencies of RSA
1716 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1717 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1718 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1719 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1720 # PK and its dependencies
1721 scripts/config.py unset MBEDTLS_PK_C
1722 scripts/config.py unset MBEDTLS_PK_PARSE_C
1723 scripts/config.py unset MBEDTLS_PK_WRITE_C
1724 scripts/config.py unset MBEDTLS_X509_USE_C
1725 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1726 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1727 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1728 scripts/config.py unset MBEDTLS_X509_CREATE_C
1729 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1730 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1731 scripts/config.py unset MBEDTLS_PKCS7_C
1732 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1733 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1734 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1735
1736 make
1737
1738 msg "test: full minus bignum"
1739 make test
1740}
1741
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001742component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001743 msg "build: default with only stream cipher"
1744
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001745 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001746 scripts/config.py unset MBEDTLS_GCM_C
1747 scripts/config.py unset MBEDTLS_CCM_C
1748 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001749 # 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 +02001750 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001751 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001752 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001753 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1754 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001755 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001756 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001757 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001758
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001759 make
1760
1761 msg "test: default with only stream cipher"
1762 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001763
1764 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001765}
1766
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001767component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001768 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001769
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001770 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001771 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001772 scripts/config.py unset MBEDTLS_GCM_C
1773 scripts/config.py unset MBEDTLS_CCM_C
1774 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001775 # 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 +02001776 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001777 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001778 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001779 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1780 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001781 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001782 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001783 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001784
Przemek Stekiel9550c052022-09-28 09:51:55 +02001785 make
1786
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001787 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001788 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001789
1790 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001791}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001792
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001793component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001794 msg "build: default with only CBC-legacy cipher"
1795
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001796 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001797 scripts/config.py unset MBEDTLS_GCM_C
1798 scripts/config.py unset MBEDTLS_CCM_C
1799 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001800 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1801 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1802 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001803 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001804 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001805 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001806 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001807 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001808 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001809
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001810 make
1811
1812 msg "test: default with only CBC-legacy cipher"
1813 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001814
1815 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1816 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001817}
1818
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001819component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001820 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001821
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001822 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001823 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001824 scripts/config.py unset MBEDTLS_GCM_C
1825 scripts/config.py unset MBEDTLS_CCM_C
1826 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001827 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1828 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1829 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001830 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001831 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001832 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001833 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001834 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001835 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001836
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001837 make
1838
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001839 msg "test: default with only CBC-legacy cipher use psa"
1840 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001841
1842 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1843 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001844}
1845
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001846component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001847 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1848
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001849 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001850 scripts/config.py unset MBEDTLS_GCM_C
1851 scripts/config.py unset MBEDTLS_CCM_C
1852 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001853 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1854 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1855 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1856 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1857 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001858 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001859 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001860 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001861 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001862
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001863 make
1864
1865 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1866 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001867
1868 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1869 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001870}
1871
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001872component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1873 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001874
1875 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001876 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001877 scripts/config.py unset MBEDTLS_GCM_C
1878 scripts/config.py unset MBEDTLS_CCM_C
1879 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001880 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1881 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1882 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1883 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1884 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001885 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001886 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001887 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001888 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001889
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001890 make
1891
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001892 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001893 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001894
1895 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1896 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001897}
1898
Valerio Setti9f0ec532022-11-08 13:03:24 +01001899# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1900# that we could use for interop testing. However, we now have sort of two
1901# implementations ourselves: one using PSA, the other not. At least test that
1902# these two interoperate with each other.
1903component_test_tls1_2_ecjpake_compatibility() {
1904 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1905 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001906 # Explicitly make lib first to avoid a race condition:
1907 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1908 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001909 make -C programs ssl/ssl_server2 ssl/ssl_client2
1910 cp programs/ssl/ssl_server2 s2_no_use_psa
1911 cp programs/ssl/ssl_client2 c2_no_use_psa
1912
1913 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1914 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1915 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001916 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001917 make -C programs ssl/ssl_server2 ssl/ssl_client2
1918 make -C programs test/udp_proxy test/query_compile_time_config
1919
Valerio Setti70e02902022-12-02 16:21:56 +01001920 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1921 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1922 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1923 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1924 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1925 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1926 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1927 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 +01001928
1929 rm s2_no_use_psa c2_no_use_psa
1930}
1931
Gilles Peskine636c26a2020-03-04 20:46:15 +01001932component_test_everest () {
1933 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
1934 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1935 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1936 make
1937
1938 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1939 make test
1940
Gilles Peskine6848d172023-11-02 19:58:03 +01001941 msg "test: metatests (clang, ASan)"
1942 tests/scripts/run-metatests.sh any asan
1943
Gilles Peskine636c26a2020-03-04 20:46:15 +01001944 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
1945 tests/ssl-opt.sh -f ECDH
1946
1947 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1948 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001949 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001950}
1951
Gilles Peskined3beca92020-07-03 00:15:37 +02001952component_test_everest_curve25519_only () {
1953 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02001954 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1955 scripts/config.py unset MBEDTLS_ECDSA_C
1956 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1957 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001958 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02001959 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001960 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02001961 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
1962
Dave Rodgman17127e92023-12-14 16:42:48 +00001963 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02001964
1965 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1966 make test
1967}
1968
Gilles Peskine8f073122018-11-27 15:58:47 +01001969component_test_small_ssl_out_content_len () {
1970 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001971 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1972 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00001973 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001974 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001975
Gilles Peskine8f073122018-11-27 15:58:47 +01001976 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001977 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01001978}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001979
Gilles Peskine8f073122018-11-27 15:58:47 +01001980component_test_small_ssl_in_content_len () {
1981 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001982 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
1983 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00001984 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001985 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001986
Gilles Peskine8f073122018-11-27 15:58:47 +01001987 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001988 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01001989}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001990
Gilles Peskine8f073122018-11-27 15:58:47 +01001991component_test_small_ssl_dtls_max_buffering () {
1992 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001993 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00001994 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001995 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001996
Gilles Peskine8f073122018-11-27 15:58:47 +01001997 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001998 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 +01001999}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002000
Gilles Peskine8f073122018-11-27 15:58:47 +01002001component_test_small_mbedtls_ssl_dtls_max_buffering () {
2002 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002003 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002004 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002005 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002006
Gilles Peskine8f073122018-11-27 15:58:47 +01002007 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002008 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002009}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002010
Gilles Peskine75cc7712019-09-06 19:47:17 +02002011component_test_psa_collect_statuses () {
2012 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002013 scripts/config.py full
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002014 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002015 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002016 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002017 rm -f tests/statuses.log
2018}
2019
Gilles Peskine8f073122018-11-27 15:58:47 +01002020component_test_full_cmake_clang () {
2021 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002022 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002023 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 +01002024 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002025
k-stachowiak0291cb72019-06-26 15:52:12 +02002026 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002027 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002028
Gilles Peskineda6017c2022-10-30 21:02:40 +01002029 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2030 programs/test/cpp_dummy_build
2031
Gilles Peskine6848d172023-11-02 19:58:03 +01002032 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002033 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002034
Gilles Peskine82b27272019-06-14 18:27:03 +02002035 msg "program demos (full config, clang)" # ~10s
2036 tests/scripts/run_demos.py
2037
k-stachowiak0291cb72019-06-26 15:52:12 +02002038 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002039 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002040
Gilles Peskine8f073122018-11-27 15:58:47 +01002041 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002042 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002043
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002044 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002045 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002046
Gilles Peskine8f073122018-11-27 15:58:47 +01002047 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002048 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002049}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002050
Gilles Peskine0c671602022-11-29 16:01:41 +01002051skip_suites_without_constant_flow () {
2052 # Skip the test suites that don't have any constant-flow annotations.
2053 # This will need to be adjusted if we ever start declaring things as
2054 # secret from macros or functions inside tests/include or tests/src.
2055 SKIP_TEST_SUITES=$(
2056 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2057 sed 's/test_suite_//; s/\.function$//' |
2058 tr '\n' ,)
2059 export SKIP_TEST_SUITES
2060}
2061
Dave Rodgman246210e2023-07-31 18:07:44 +01002062skip_all_except_given_suite () {
2063 # Skip all but the given test suite
2064 SKIP_TEST_SUITES=$(
2065 ls -1 tests/suites/test_suite_*.function |
2066 grep -v $1.function |
2067 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2068 tr '\n' ,)
2069 export SKIP_TEST_SUITES
2070}
2071
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002072component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002073 # This tests both (1) accesses to undefined memory, and (2) branches or
2074 # memory access depending on secret values. To distinguish between those:
2075 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2076 # - or alternatively, change the build type to MemSanDbg, which enables
2077 # origin tracking and nicer stack traces (which are useful for debugging
2078 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002079 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2080 scripts/config.py full
2081 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2082 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2083 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2084 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2085 make
2086
2087 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2088 make test
2089}
2090
2091component_test_memsan_constant_flow_psa () {
2092 # This tests both (1) accesses to undefined memory, and (2) branches or
2093 # memory access depending on secret values. To distinguish between those:
2094 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2095 # - or alternatively, change the build type to MemSanDbg, which enables
2096 # origin tracking and nicer stack traces (which are useful for debugging
2097 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002098 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002099 scripts/config.py full
2100 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2101 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2102 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2103 make
2104
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002105 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002106 make test
2107}
2108
Bence Szépkúti0354d042023-12-06 16:14:37 +01002109component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002110 # This tests both (1) everything that valgrind's memcheck usually checks
2111 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2112 # etc.) and (2) branches or memory access depending on secret values,
2113 # which will be reported as uninitialized memory. To distinguish between
2114 # secret and actually uninitialized:
2115 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2116 # - or alternatively, build with debug info and manually run the offending
2117 # test suite with valgrind --track-origins=yes, then check if the origin
2118 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002119 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2120 scripts/config.py full
2121 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2122 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002123 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002124 cmake -D CMAKE_BUILD_TYPE:String=Release .
2125 make
2126
2127 # this only shows a summary of the results (how many of each type)
2128 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002129 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002130 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002131
2132 # Test asm path in constant time module - by default, it will test the plain C
2133 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2134 msg "test: valgrind asm constant_time"
2135 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2136 skip_all_except_given_suite test_suite_constant_time
2137 cmake -D CMAKE_BUILD_TYPE:String=Release .
2138 make clean
2139 make
2140 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002141}
2142
Bence Szépkúti0354d042023-12-06 16:14:37 +01002143component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002144 # This tests both (1) everything that valgrind's memcheck usually checks
2145 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2146 # etc.) and (2) branches or memory access depending on secret values,
2147 # which will be reported as uninitialized memory. To distinguish between
2148 # secret and actually uninitialized:
2149 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2150 # - or alternatively, build with debug info and manually run the offending
2151 # test suite with valgrind --track-origins=yes, then check if the origin
2152 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002153 msg "build: cmake release GCC, full config with constant flow testing"
2154 scripts/config.py full
2155 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002156 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002157 cmake -D CMAKE_BUILD_TYPE:String=Release .
2158 make
2159
2160 # this only shows a summary of the results (how many of each type)
2161 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002162 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002163 make memcheck
2164}
2165
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002166component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002167 # Test that removing the deprecated features from the default
2168 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002169 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2170 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
2171 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2172
2173 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2174 make test
2175}
2176
2177component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002178 msg "build: make, full_no_deprecated config" # ~ 30s
2179 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002180 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2181
Gilles Peskine30de2e82020-04-20 21:39:22 +02002182 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002183 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002184
2185 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2186 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002187}
2188
Gilles Peskine8386ea22020-04-30 09:07:29 +02002189component_test_full_no_deprecated_deprecated_warning () {
2190 # Test that there is nothing deprecated in "full_no_deprecated".
2191 # A deprecated feature would trigger a warning (made fatal) from
2192 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002193 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2194 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002195 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2196 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
2197 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2198
Gilles Peskine30de2e82020-04-20 21:39:22 +02002199 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002200 make test
2201}
2202
Gilles Peskine8386ea22020-04-30 09:07:29 +02002203component_test_full_deprecated_warning () {
2204 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2205 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002206 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002207 scripts/config.py full
2208 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002209 # Expect warnings from '#warning' directives in check_config.h.
2210 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002211
Gilles Peskine8386ea22020-04-30 09:07:29 +02002212 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2213 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2214 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002215 # Expect warnings from '#warning' directives in check_config.h and
2216 # from the use of deprecated functions in test suites.
2217 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 +01002218
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002219 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2220 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002221
2222 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2223 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002224}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002225
Gilles Peskineec541fe2020-01-31 14:24:14 +01002226# Check that the specified libraries exist and are empty.
2227are_empty_libraries () {
2228 nm "$@" >/dev/null 2>/dev/null
2229 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2230}
2231
2232component_build_crypto_default () {
2233 msg "build: make, crypto only"
2234 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002235 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002236 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002237}
2238
2239component_build_crypto_full () {
2240 msg "build: make, crypto only, full config"
2241 scripts/config.py crypto_full
Gilles Peskine6bb39152020-02-03 11:59:20 +01002242 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002243 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002244}
2245
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002246component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002247 msg "build: make, config for PSA crypto service"
2248 scripts/config.py crypto
2249 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2250 # Disable things that are not needed for just cryptography, to
2251 # reach a configuration that would be typical for a PSA cryptography
2252 # service providing all implemented PSA algorithms.
2253 # System stuff
2254 scripts/config.py unset MBEDTLS_ERROR_C
2255 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002256 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002257 # Crypto stuff with no PSA interface
2258 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002259 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002260 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002261 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002262 scripts/config.py unset MBEDTLS_NIST_KW_C
2263 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2264 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2265 scripts/config.py unset MBEDTLS_PKCS12_C
2266 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002267 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2268 # in PSA code to work with RSA keys. We don't require users to set those:
2269 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002270 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002271 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002272 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002273 make CFLAGS='-O1 -Werror' all test
2274 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2275}
2276
Gilles Peskineec541fe2020-01-31 14:24:14 +01002277component_build_crypto_baremetal () {
2278 msg "build: make, crypto only, baremetal config"
2279 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002280 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002281 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002282}
Daniel Axtens446af202020-09-02 21:30:13 +10002283support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002284 support_build_baremetal "$@"
2285}
2286
2287component_build_baremetal () {
2288 msg "build: make, baremetal config"
2289 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002290 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002291}
2292support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002293 # Older Glibc versions include time.h from other headers such as stdlib.h,
2294 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2295 # problem, Ubuntu 18.04 is ok.
2296 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2297}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002298
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002299# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002300component_test_depends_py_cipher_id () {
2301 msg "test/build: depends.py cipher_id (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002302 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002303}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002304
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002305component_test_depends_py_cipher_chaining () {
2306 msg "test/build: depends.py cipher_chaining (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002307 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002308}
2309
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002310component_test_depends_py_cipher_padding () {
2311 msg "test/build: depends.py cipher_padding (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002312 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002313}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002314
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002315component_test_depends_py_curves () {
2316 msg "test/build: depends.py curves (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002317 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002318}
2319
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002320component_test_depends_py_hashes () {
2321 msg "test/build: depends.py hashes (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002322 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002323}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002324
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002325component_test_depends_py_kex () {
2326 msg "test/build: depends.py kex (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002327 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002328}
2329
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002330component_test_depends_py_pkalgs () {
2331 msg "test/build: depends.py pkalgs (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002332 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002333}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002334
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002335# PSA equivalents of the depends.py tests
2336component_test_depends_py_cipher_id_psa () {
2337 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2338 tests/scripts/depends.py cipher_id
2339}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002340
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002341component_test_depends_py_cipher_chaining_psa () {
2342 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2343 tests/scripts/depends.py cipher_chaining
2344}
2345
2346component_test_depends_py_cipher_padding_psa () {
2347 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2348 tests/scripts/depends.py cipher_padding
2349}
2350
2351component_test_depends_py_curves_psa () {
2352 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2353 tests/scripts/depends.py curves
2354}
2355
2356component_test_depends_py_hashes_psa () {
2357 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2358 tests/scripts/depends.py hashes
2359}
2360
2361component_test_depends_py_kex_psa () {
2362 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2363 tests/scripts/depends.py kex
2364}
2365
2366component_test_depends_py_pkalgs_psa () {
2367 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002368 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002369}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002370
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002371component_build_no_pk_rsa_alt_support () {
2372 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2373
2374 scripts/config.py full
2375 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2376 scripts/config.py set MBEDTLS_RSA_C
2377 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2378
2379 # Only compile - this is primarily to test for compile issues
2380 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
2381}
2382
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002383component_build_module_alt () {
2384 msg "build: MBEDTLS_XXX_ALT" # ~30s
2385 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002386
2387 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002388 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2389 scripts/config.py unset MBEDTLS_AESNI_C
2390 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002391 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002392 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2393 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002394 # You can only have one threading implementation: alt or pthread, not both.
2395 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002396 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2397 # directly and assumes the implementation works with partial groups.
2398 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002399 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2400 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2401 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002402 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2403 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2404 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002405
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002406 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2407 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2408 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002409 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002410
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002411 # We can only compile, not link, since we don't have any implementations
2412 # suitable for testing with the dummy alt headers.
2413 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
2414}
2415
2416component_build_dhm_alt () {
2417 msg "build: MBEDTLS_DHM_ALT" # ~30s
2418 scripts/config.py full
2419 scripts/config.py set MBEDTLS_DHM_ALT
2420 # debug.c currently references mbedtls_dhm_context fields directly.
2421 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002422 # We can only compile, not link, since we don't have any implementations
2423 # suitable for testing with the dummy alt headers.
2424 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
2425}
2426
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002427component_test_no_use_psa_crypto_full_cmake_asan() {
2428 # full minus MBEDTLS_USE_PSA_CRYPTO: run the same set of tests as basic-build-test.sh
Gilles Peskinedc3a1792019-09-03 11:42:04 +02002429 msg "build: cmake, full config minus MBEDTLS_USE_PSA_CRYPTO, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002430 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002431 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
2432 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002433 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002434 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002435 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002436 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002437 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002438 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002439 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002440 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002441
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002442 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002443 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002444
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002445 # Note: ssl-opt.sh has some test cases that depend on
2446 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2447 # This is the only component where those tests are not skipped.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002448 msg "test: ssl-opt.sh (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002449 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002450
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002451 msg "test: compat.sh default (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002452 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002453
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002454 msg "test: compat.sh NULL (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002455 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002456
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002457 msg "test: compat.sh ARIA + ChachaPoly (full minus MBEDTLS_USE_PSA_CRYPTO)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002458 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002459}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002460
Ronald Cron403c15c2021-09-13 09:38:05 +02002461component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002462 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002463
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002464 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002465 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002466 $(helper_get_psa_key_type_list "ECC") \
2467 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002468
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002469 # Configure
2470 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002471
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002472 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002473 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard6d7db932022-12-28 09:48:01 +01002474 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002475
2476 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002477 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002478
2479 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002480 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2481 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2482
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002483 # Build
2484 # -----
2485
2486 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002487 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2488 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002489
2490 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2491
Valerio Setti3fe105b2023-10-30 11:08:12 +01002492 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002493
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002494 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002495 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002496
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002497 # Run the tests
2498 # -------------
2499
Ronald Cron403c15c2021-09-13 09:38:05 +02002500 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2501 make test
2502}
2503
Valerio Setti44b178c2023-03-22 14:02:57 +01002504component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002505 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002506
2507 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002508 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002509 $(helper_get_psa_key_type_list "ECC") \
2510 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002511
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002512 # Configure
2513 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002514
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002515 # Start from default config (no TLS 1.3, no USE_PSA)
2516 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002517
Valerio Setti44b178c2023-03-22 14:02:57 +01002518 # Disable the module that's accelerated
2519 scripts/config.py unset MBEDTLS_ECDH_C
2520
2521 # Disable things that depend on it
2522 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2523 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2524 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2525 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2526 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2527
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002528 # Build
2529 # -----
2530
2531 helper_libtestdriver1_make_drivers "$loc_accel_list"
2532
Valerio Setti3fe105b2023-10-30 11:08:12 +01002533 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002534
Valerio Setti44b178c2023-03-22 14:02:57 +01002535 # Make sure this was not re-enabled by accident (additive config)
2536 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002537
2538 # Run the tests
2539 # -------------
2540
Valerio Setti44b178c2023-03-22 14:02:57 +01002541 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002542 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002543}
2544
Przemek Stekieldccb2022023-05-11 10:48:50 +02002545component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002546 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002547
2548 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002549 loc_accel_list="ALG_FFDH \
Valerio Setti0a342c92023-09-01 09:12:31 +02002550 $(helper_get_psa_key_type_list "DH")"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002551
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002552 # Configure
2553 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002554
Przemek Stekiel565353e2023-07-05 11:07:07 +02002555 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002556 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002557
2558 # Disable the module that's accelerated
2559 scripts/config.py unset MBEDTLS_DHM_C
2560
2561 # Disable things that depend on it
2562 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2563 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2564
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002565 # Build
2566 # -----
2567
2568 helper_libtestdriver1_make_drivers "$loc_accel_list"
2569
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002570 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002571
2572 # Make sure this was not re-enabled by accident (additive config)
2573 not grep mbedtls_dhm_ library/dhm.o
2574
2575 # Run the tests
2576 # -------------
2577
Gilles Peskine14302ed2023-07-19 19:30:04 +02002578 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002579 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002580
Gilles Peskine14302ed2023-07-19 19:30:04 +02002581 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002582 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002583}
2584
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002585component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002586 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002587
2588 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002589 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002590
2591 # Disable things that are not supported
2592 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2593 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002594 make
2595
Gilles Peskine14302ed2023-07-19 19:30:04 +02002596 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002597 make test
2598
Gilles Peskine14302ed2023-07-19 19:30:04 +02002599 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002600 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002601}
2602
Valerio Setti44b178c2023-03-22 14:02:57 +01002603component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002604 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002605
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002606 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002607 $(helper_get_psa_key_type_list "ECC") \
2608 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002609
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002610 # Configure
2611 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002612
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002613 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002614
2615 # Make built-in fallback not available
2616 scripts/config.py unset MBEDTLS_ECJPAKE_C
2617 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2618
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002619 # Build
2620 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002621
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002622 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002623
Valerio Setti3fe105b2023-10-30 11:08:12 +01002624 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002625
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002626 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002627 not grep mbedtls_ecjpake_init library/ecjpake.o
2628
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002629 # Run the tests
2630 # -------------
2631
Gilles Peskine14302ed2023-07-19 19:30:04 +02002632 msg "test: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002633 make test
2634}
2635
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002636component_test_psa_crypto_config_accel_ecc_some_key_types () {
2637 msg "build: full with accelerated EC algs and some key types"
2638
2639 # Algorithms and key types to accelerate
2640 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2641 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2642 ALG_ECDH \
2643 ALG_JPAKE \
2644 KEY_TYPE_ECC_PUBLIC_KEY \
2645 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2646 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002647 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2648 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002649
2650 # Configure
2651 # ---------
2652
2653 # start with config full for maximum coverage (also enables USE_PSA)
2654 helper_libtestdriver1_adjust_config "full"
2655
2656 # Disable modules that are accelerated - some will be re-enabled
2657 scripts/config.py unset MBEDTLS_ECDSA_C
2658 scripts/config.py unset MBEDTLS_ECDH_C
2659 scripts/config.py unset MBEDTLS_ECJPAKE_C
2660 scripts/config.py unset MBEDTLS_ECP_C
2661
2662 # Disable all curves - those that aren't accelerated should be re-enabled
2663 helper_disable_builtin_curves
2664
2665 # Restartable feature is not yet supported by PSA. Once it will in
2666 # the future, the following line could be removed (see issues
2667 # 6061, 6332 and following ones)
2668 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2669
2670 # this is not supported by the driver API yet
2671 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2672
2673 # Build
2674 # -----
2675
2676 # These hashes are needed for some ECDSA signature tests.
2677 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2678 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2679 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2680
Valerio Setti3fe105b2023-10-30 11:08:12 +01002681 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002682
2683 # ECP should be re-enabled but not the others
2684 not grep mbedtls_ecdh_ library/ecdh.o
2685 not grep mbedtls_ecdsa library/ecdsa.o
2686 not grep mbedtls_ecjpake library/ecjpake.o
2687 grep mbedtls_ecp library/ecp.o
2688
2689 # Run the tests
2690 # -------------
2691
2692 msg "test suites: full with accelerated EC algs and some key types"
2693 make test
2694}
2695
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002696# Run tests with only (non-)Weierstrass accelerated
2697# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002698# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2699# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002700common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002701 weierstrass=$1
2702 if [ $weierstrass -eq 1 ]; then
2703 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002704 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002705 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002706 fi
2707
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002708 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002709
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002710 # Note: Curves are handled in a special way by the libtestdriver machinery,
2711 # so we only want to include them in the accel list when building the main
2712 # libraries, hence the use of a separate variable.
2713 # Note: the following loop is a modified version of
2714 # helper_get_psa_curve_list that only keeps Weierstrass families.
2715 loc_weierstrass_list=""
2716 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002717 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2718 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002719 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002720 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002721 ;;
2722 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002723 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002724 ;;
2725 esac
2726 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002727 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002728 loc_curve_list=$loc_weierstrass_list
2729 else
2730 loc_curve_list=$loc_non_weierstrass_list
2731 fi
2732
Valerio Setti3fe105b2023-10-30 11:08:12 +01002733 # Algorithms and key types to accelerate
2734 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2735 ALG_ECDH \
2736 ALG_JPAKE \
2737 $(helper_get_psa_key_type_list "ECC") \
2738 $loc_curve_list"
2739
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002740 # Configure
2741 # ---------
2742
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002743 # Start with config crypto_full and remove PK_C:
2744 # that's what's supported now, see docs/driver-only-builds.md.
2745 helper_libtestdriver1_adjust_config "crypto_full"
2746 scripts/config.py unset MBEDTLS_PK_C
2747 scripts/config.py unset MBEDTLS_PK_PARSE_C
2748 scripts/config.py unset MBEDTLS_PK_WRITE_C
2749 # We need to disable RSA too or PK will be re-enabled.
2750 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
2751 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_ALG_RSA_[0-9A-Z_a-z]*"
2752 scripts/config.py unset MBEDTLS_RSA_C
2753 scripts/config.py unset MBEDTLS_PKCS1_V15
2754 scripts/config.py unset MBEDTLS_PKCS1_V21
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002755
2756 # Disable modules that are accelerated - some will be re-enabled
2757 scripts/config.py unset MBEDTLS_ECDSA_C
2758 scripts/config.py unset MBEDTLS_ECDH_C
2759 scripts/config.py unset MBEDTLS_ECJPAKE_C
2760 scripts/config.py unset MBEDTLS_ECP_C
2761
2762 # Disable all curves - those that aren't accelerated should be re-enabled
2763 helper_disable_builtin_curves
2764
2765 # Restartable feature is not yet supported by PSA. Once it will in
2766 # the future, the following line could be removed (see issues
2767 # 6061, 6332 and following ones)
2768 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2769
2770 # this is not supported by the driver API yet
2771 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2772
2773 # Build
2774 # -----
2775
2776 # These hashes are needed for some ECDSA signature tests.
2777 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2778 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2779 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2780
Valerio Settiac7a8092023-10-31 12:23:44 +01002781 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002782
2783 # We expect ECDH to be re-enabled for the missing curves
2784 grep mbedtls_ecdh_ library/ecdh.o
2785 # We expect ECP to be re-enabled, however the parts specific to the
2786 # families of curves that are accelerated should be ommited.
2787 # - functions with mxz in the name are specific to Montgomery curves
2788 # - ecp_muladd is specific to Weierstrass curves
2789 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002790 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002791 not grep mbedtls_ecp_muladd library/ecp.o
2792 grep mxz library/ecp.o
2793 else
2794 grep mbedtls_ecp_muladd library/ecp.o
2795 not grep mxz library/ecp.o
2796 fi
2797 # We expect ECDSA and ECJPAKE to be re-enabled only when
2798 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002799 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002800 not grep mbedtls_ecdsa library/ecdsa.o
2801 not grep mbedtls_ecjpake library/ecjpake.o
2802 else
2803 grep mbedtls_ecdsa library/ecdsa.o
2804 grep mbedtls_ecjpake library/ecjpake.o
2805 fi
2806
2807 # Run the tests
2808 # -------------
2809
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002810 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2811 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002812}
2813
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002814component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002815 common_test_psa_crypto_config_accel_ecc_some_curves 1
2816}
2817
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002818component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002819 common_test_psa_crypto_config_accel_ecc_some_curves 0
2820}
2821
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002822# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2823# ECDH, ECDSA) with and without drivers.
2824# The input parameter is a boolean value which indicates:
2825# - 0 keep built-in EC algs,
2826# - 1 exclude built-in EC algs (driver only).
2827#
2828# This is used by the two following components to ensure they always use the
2829# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002830# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2831# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002832# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002833config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002834 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002835 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002836 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002837 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002838 # Disable modules that are accelerated
2839 scripts/config.py unset MBEDTLS_ECDSA_C
2840 scripts/config.py unset MBEDTLS_ECDH_C
2841 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002842 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002843 fi
2844
2845 # Restartable feature is not yet supported by PSA. Once it will in
2846 # the future, the following line could be removed (see issues
2847 # 6061, 6332 and following ones)
2848 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002849}
2850
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002851# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2852component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002853 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002854
2855 # Algorithms and key types to accelerate
2856 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2857 ALG_ECDH \
2858 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002859 $(helper_get_psa_key_type_list "ECC") \
2860 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002861
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002862 # Configure
2863 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002864
2865 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002866 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002867
Valerio Setti0a342c92023-09-01 09:12:31 +02002868 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002869 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2870 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002871
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002872 # Build
2873 # -----
2874
2875 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002876 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2877 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002878 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2879
Valerio Setti3fe105b2023-10-30 11:08:12 +01002880 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002881
2882 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2883 not grep mbedtls_ecdsa_ library/ecdsa.o
2884 not grep mbedtls_ecdh_ library/ecdh.o
2885 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002886 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002887
2888 # Run the tests
2889 # -------------
2890
Gilles Peskine14302ed2023-07-19 19:30:04 +02002891 msg "test suites: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002892 make test
2893
Gilles Peskine14302ed2023-07-19 19:30:04 +02002894 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002895 tests/ssl-opt.sh
2896}
2897
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002898# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2899component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002900 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002901
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002902 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002903
2904 make
2905
Gilles Peskine14302ed2023-07-19 19:30:04 +02002906 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002907 make test
2908
Gilles Peskine14302ed2023-07-19 19:30:04 +02002909 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002910 tests/ssl-opt.sh
2911}
2912
Valerio Settie618cb02023-04-12 14:59:16 +02002913# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002914# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2915# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002916# to ensure that both tests use the same underlying configuration when testing
2917# driver's coverage with analyze_outcomes.py.
2918#
2919# This functions accepts 1 boolean parameter as follows:
2920# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2921# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2922# - 0: include built-in implementation of EC algorithms.
2923#
2924# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2925# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002926config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002927 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002928 # start with full config for maximum coverage (also enables USE_PSA)
2929 helper_libtestdriver1_adjust_config "full"
2930
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002931 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002932 # Disable modules that are accelerated
2933 scripts/config.py unset MBEDTLS_ECDSA_C
2934 scripts/config.py unset MBEDTLS_ECDH_C
2935 scripts/config.py unset MBEDTLS_ECJPAKE_C
2936 # Disable ECP module (entirely)
2937 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002938 fi
2939
Valerio Settiaecd32c2023-06-14 10:42:31 +02002940 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2941 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002942 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002943 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002944
Valerio Settie618cb02023-04-12 14:59:16 +02002945 # Restartable feature is not yet supported by PSA. Once it will in
2946 # the future, the following line could be removed (see issues
2947 # 6061, 6332 and following ones)
2948 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002949}
2950
2951# Build and test a configuration where driver accelerates all EC algs while
2952# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2953# side.
2954#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002955# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2956component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002957 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002958
2959 # Algorithms and key types to accelerate
2960 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2961 ALG_ECDH \
2962 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002963 $(helper_get_psa_key_type_list "ECC") \
2964 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02002965
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002966 # Configure
2967 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002968
Valerio Settie618cb02023-04-12 14:59:16 +02002969 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002970 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02002971 # Disable all the builtin curves. All the required algs are accelerated.
2972 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02002973
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002974 # Build
2975 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02002976
2977 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002978 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
2979 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2980 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02002981
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02002982 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02002983
Valerio Setti3fe105b2023-10-30 11:08:12 +01002984 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02002985
2986 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2987 not grep mbedtls_ecdsa_ library/ecdsa.o
2988 not grep mbedtls_ecdh_ library/ecdh.o
2989 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02002990 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02002991 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02002992
2993 # Run the tests
2994 # -------------
2995
Gilles Peskine14302ed2023-07-19 19:30:04 +02002996 msg "test: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002997 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02002998
Gilles Peskine14302ed2023-07-19 19:30:04 +02002999 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003000 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003001}
3002
3003# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003004# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003005# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003006component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003007 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003008
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003009 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003010
3011 make
3012
Gilles Peskine14302ed2023-07-19 19:30:04 +02003013 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003014 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003015
Gilles Peskine14302ed2023-07-19 19:30:04 +02003016 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003017 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003018}
3019
Valerio Setti4e2f2442023-08-15 10:10:26 +02003020# This is a common configuration helper used directly from:
3021# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3022# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3023# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003024# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003025# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003026# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003027# - this is the reference component of the above
3028# - it still disables RSA and FFDH, but it uses builtin EC algs
3029# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3030# - accelerate all EC and FFDH algs, disable only RSA
3031# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3032# - this is the reference component of the above
3033# - it still disables RSA, but it uses builtin EC and FFDH algs
3034#
3035# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003036# $1: a boolean value which states if we are testing an accelerated scenario
3037# or not.
3038# $2: a string value which states which components are tested. Allowed values
3039# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003040config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003041 driver_only="$1"
3042 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003043 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003044 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003045
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003046 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003047 # Disable modules that are accelerated
3048 scripts/config.py unset MBEDTLS_ECDSA_C
3049 scripts/config.py unset MBEDTLS_ECDH_C
3050 scripts/config.py unset MBEDTLS_ECJPAKE_C
3051 # Disable ECP module (entirely)
3052 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003053 # Also disable bignum
3054 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003055 fi
3056
3057 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3058 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3059 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3060 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3061
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003062 # RSA support is intentionally disabled on this test because RSA_C depends
3063 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003064 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3065 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 +02003066 scripts/config.py unset MBEDTLS_RSA_C
3067 scripts/config.py unset MBEDTLS_PKCS1_V15
3068 scripts/config.py unset MBEDTLS_PKCS1_V21
3069 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3070 # Also disable key exchanges that depend on RSA
3071 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3072 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3073 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3074 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3075 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3076
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003077 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003078 # When testing ECC only, we disable FFDH support, both from builtin and
3079 # PSA sides, and also disable the key exchanges that depend on DHM.
3080 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3081 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
3082 scripts/config.py unset MBEDTLS_DHM_C
3083 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3084 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3085 else
3086 # When testing ECC and DH instead, we disable DHM and depending key
3087 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003088 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003089 scripts/config.py unset MBEDTLS_DHM_C
3090 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3091 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3092 fi
3093 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003094
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003095 # Restartable feature is not yet supported by PSA. Once it will in
3096 # the future, the following line could be removed (see issues
3097 # 6061, 6332 and following ones)
3098 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3099}
3100
Valerio Setti4e2f2442023-08-15 10:10:26 +02003101# Common helper used by:
3102# - component_test_psa_crypto_config_accel_ecc_no_bignum
3103# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003104#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003105# The goal is to build and test accelerating either:
3106# - ECC only or
3107# - both ECC and FFDH
3108#
3109# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003110# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3111# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003112common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003113 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003114
Valerio Setti5dfaca42023-09-05 08:48:51 +02003115 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003116 if [ "$test_target" = "ECC_DH" ]; then
3117 accel_text="ECC/FFDH"
3118 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003119 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003120 accel_text="ECC"
3121 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003122 fi
3123
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003124 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003125
3126 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003127 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3128 ALG_ECDH \
3129 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003130 $(helper_get_psa_key_type_list "ECC") \
3131 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003132 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003133 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003134 loc_accel_list="$loc_accel_list \
3135 ALG_FFDH \
Manuel Pégourié-Gonnard85ff5e62023-09-22 09:05:48 +02003136 $(helper_get_psa_key_type_list "DH")"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003137 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003138
3139 # Configure
3140 # ---------
3141
3142 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003143 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003144 # Disable all the builtin curves. All the required algs are accelerated.
3145 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003146
3147 # Build
3148 # -----
3149
3150 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003151 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3152 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3153 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003154
3155 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3156
Valerio Setti3fe105b2023-10-30 11:08:12 +01003157 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003158
3159 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3160 not grep mbedtls_ecdsa_ library/ecdsa.o
3161 not grep mbedtls_ecdh_ library/ecdh.o
3162 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003163 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003164 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003165 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003166 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003167 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003168
3169 # Run the tests
3170 # -------------
3171
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003172 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003173
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003174 make test
3175
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003176 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003177 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003178}
3179
Valerio Setti4e2f2442023-08-15 10:10:26 +02003180# Common helper used by:
3181# - component_test_psa_crypto_config_reference_ecc_no_bignum
3182# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3183#
3184# The goal is to build and test a reference scenario (i.e. with builtin
3185# components) compared to the ones used in
3186# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3187#
3188# It is meant to be used in conjunction with
3189# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3190# coverage analysis in "analyze_outcomes.py" script.
3191common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003192 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003193
Valerio Setti5dfaca42023-09-05 08:48:51 +02003194 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003195 if [ "$test_target" = "ECC_DH" ]; then
3196 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003197 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003198 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003199 fi
3200
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003201 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003202
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003203 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003204
3205 make
3206
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003207 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003208 make test
3209
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003210 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003211 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003212}
3213
Valerio Setti4e2f2442023-08-15 10:10:26 +02003214component_test_psa_crypto_config_accel_ecc_no_bignum () {
3215 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3216}
3217
3218component_test_psa_crypto_config_reference_ecc_no_bignum () {
3219 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3220}
3221
3222component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3223 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3224}
3225
3226component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3227 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3228}
3229
Valerio Settiac6d35f2023-08-04 12:49:11 +02003230# Helper for setting common configurations between:
3231# - component_test_tfm_config_p256m_driver_accel_ec()
3232# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003233common_tfm_config () {
3234 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003235 cp configs/config-tfm.h "$CONFIG_H"
3236 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3237 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003238
Yanray Wang73bb2312023-09-25 11:21:15 +08003239 # Other config adjustment to make the tests pass.
3240 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003241 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003242 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3243 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003244
Yanray Wang73bb2312023-09-25 11:21:15 +08003245 # Config adjustment for better test coverage in our environment.
3246 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003247 #
3248 # Enable filesystem I/O for the benefit of PK parse/write tests.
3249 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3250}
3251
Valerio Settiac6d35f2023-08-04 12:49:11 +02003252# Keep this in sync with component_test_tfm_config() as they are both meant
3253# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003254component_test_tfm_config_p256m_driver_accel_ec () {
3255 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3256
3257 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003258
Dave Rodgman897bb772023-11-15 16:34:20 +00003259 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003260 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003261
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003262 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3263 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003264 not grep mbedtls_ecdh_ library/ecdh.o
3265 not grep mbedtls_ecjpake_ library/ecjpake.o
3266 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3267 not grep mbedtls_ecp_ library/ecp.o
3268 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003269 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003270 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003271 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003272 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003273
Valerio Setti5e18b902023-12-04 12:07:30 +01003274 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3275 # files, so we want to ensure that it has not be re-enabled accidentally.
3276 not grep mbedtls_cipher library/cipher.o
3277
Valerio Settib7e95442023-03-21 11:52:33 +01003278 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003279 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003280 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003281}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003282
Valerio Settiac6d35f2023-08-04 12:49:11 +02003283# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3284# they are both meant to be used in analyze_outcomes.py for driver's coverage
3285# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003286component_test_tfm_config() {
3287 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003288
Dave Rodgman897bb772023-11-15 16:34:20 +00003289 # Disable P256M driver, which is on by default, so that analyze_outcomes
3290 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3291 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3292
Valerio Setti52ba0e32023-08-04 12:43:03 +02003293 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003294 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003295
Dave Rodgman897bb772023-11-15 16:34:20 +00003296 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003297 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003298
Valerio Setti5e18b902023-12-04 12:07:30 +01003299 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3300 # files, so we want to ensure that it has not be re-enabled accidentally.
3301 not grep mbedtls_cipher library/cipher.o
3302
Valerio Setti52ba0e32023-08-04 12:43:03 +02003303 msg "test: TF-M config"
3304 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003305}
3306
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003307# Common helper for component_full_without_ecdhe_ecdsa() and
3308# component_full_without_ecdhe_ecdsa_and_tls13() which:
3309# - starts from the "full" configuration minus the list of symbols passed in
3310# as 1st parameter
3311# - build
3312# - test only TLS (i.e. test_suite_tls and ssl-opt)
3313build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003314 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003315
3316 msg "build: full minus something, test TLS"
3317
3318 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003319 for sym in $symbols_to_disable; do
3320 echo "Disabling $sym"
3321 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003322 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003323
Valerio Settiee97a1e2023-03-27 12:44:15 +02003324 make
3325
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003326 msg "test: full minus something, test TLS"
3327 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003328
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003329 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003330 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003331}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003332
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003333component_full_without_ecdhe_ecdsa () {
3334 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003335}
3336
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003337component_full_without_ecdhe_ecdsa_and_tls13 () {
3338 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3339 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003340}
3341
Valerio Setti249b18a2023-06-20 12:08:30 +02003342# This is an helper used by:
3343# - component_test_psa_ecc_key_pair_no_derive
3344# - component_test_psa_ecc_key_pair_no_generate
3345# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3346# enabled, but one. Input arguments are as follows:
3347# - $1 is the key type under test, i.e. ECC/RSA/DH
3348# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003349build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003350 key_type=$1
3351 unset_option=$2
3352 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003353
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003354 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003355 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003356 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3357 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3358
3359 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3360 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003361 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003362
Dave Rodgman17127e92023-12-14 16:42:48 +00003363 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003364
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003365 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003366 make test
3367}
3368
3369component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003370 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003371}
3372
3373component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003374 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003375}
3376
Pengyu Lve705f572023-12-06 16:38:15 +08003377config_psa_crypto_accel_rsa () {
3378 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003379
Pengyu Lve705f572023-12-06 16:38:15 +08003380 # Start from crypto_full config (no X.509, no TLS)
3381 helper_libtestdriver1_adjust_config "crypto_full"
3382
3383 if [ "$driver_only" -eq 1 ]; then
3384 # Remove RSA support and its dependencies
3385 scripts/config.py unset MBEDTLS_RSA_C
3386 scripts/config.py unset MBEDTLS_PKCS1_V15
3387 scripts/config.py unset MBEDTLS_PKCS1_V21
3388
3389 # We need PEM parsing in the test library as well to support the import
3390 # of PEM encoded RSA keys.
3391 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3392 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3393 fi
3394}
3395
3396component_test_psa_crypto_config_accel_rsa_crypto () {
3397 msg "build: crypto_full with accelerated RSA"
3398
3399 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3400 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3401 KEY_TYPE_RSA_PUBLIC_KEY \
3402 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3403 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3404 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3405 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003406
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003407 # Configure
3408 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003409
Pengyu Lve705f572023-12-06 16:38:15 +08003410 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003411
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003412 # Build
3413 # -----
3414
Pengyu Lve705f572023-12-06 16:38:15 +08003415 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003416 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
Pengyu Lve705f572023-12-06 16:38:15 +08003417 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003418 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003419
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003420 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003421
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003422 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003423 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003424
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003425 # Run the tests
3426 # -------------
3427
Pengyu Lve705f572023-12-06 16:38:15 +08003428 msg "test: crypto_full with accelerated RSA"
3429 make test
3430}
3431
3432component_test_psa_crypto_config_reference_rsa_crypto () {
3433 msg "build: crypto_full with non-accelerated RSA"
3434
3435 # Configure
3436 # ---------
3437 config_psa_crypto_accel_rsa 0
3438
3439 # Build
3440 # -----
3441 make
3442
3443 # Run the tests
3444 # -------------
3445 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003446 make test
3447}
3448
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003449# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003450# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003451component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003452 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003453
Valerio Setti4590bc22023-06-13 15:39:23 +02003454 # Create a temporary output file unless there is already one set
3455 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3456 REMOVE_OUTCOME_ON_EXIT="no"
3457 else
3458 REMOVE_OUTCOME_ON_EXIT="yes"
3459 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3460 export MBEDTLS_TEST_OUTCOME_FILE
3461 fi
3462
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003463 # Start from crypto configuration
3464 scripts/config.py crypto
3465
3466 # Remove RSA support and its dependencies
3467 scripts/config.py unset MBEDTLS_PKCS1_V15
3468 scripts/config.py unset MBEDTLS_PKCS1_V21
3469 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3470 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3471 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3472 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3473 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3474 scripts/config.py unset MBEDTLS_RSA_C
3475 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3476
3477 # Enable PSA support
3478 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3479
Valerio Setti01cc88a2023-06-15 11:53:08 +02003480 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003481 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003482 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3483 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3484 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003485
3486 make
3487
Valerio Setti01cc88a2023-06-15 11:53:08 +02003488 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003489 make test
3490
3491 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3492 # performing RSA signature.
3493 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3494 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3495
3496 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3497 rm $MBEDTLS_TEST_OUTCOME_FILE
3498 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003499}
3500
Ronald Cronb2312452021-05-08 14:32:59 +02003501component_test_psa_crypto_config_accel_hash () {
3502 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3503
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003504 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3505 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3506 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003507
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003508 # Configure
3509 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003510
3511 # Start from default config (no TLS 1.3, no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003512 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003513
3514 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003515 scripts/config.py unset MBEDTLS_MD5_C
3516 scripts/config.py unset MBEDTLS_RIPEMD160_C
3517 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003518 scripts/config.py unset MBEDTLS_SHA224_C
3519 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003520 scripts/config.py unset MBEDTLS_SHA384_C
3521 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003522 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003523
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003524 # Build
3525 # -----
3526
3527 helper_libtestdriver1_make_drivers "$loc_accel_list"
3528
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003529 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003530
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003531 # There's a risk of something getting re-enabled via config_psa.h;
3532 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3533 not grep mbedtls_md5 library/md5.o
3534 not grep mbedtls_sha1 library/sha1.o
3535 not grep mbedtls_sha256 library/sha256.o
3536 not grep mbedtls_sha512 library/sha512.o
3537 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003538
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003539 # Run the tests
3540 # -------------
3541
Ronald Cronb2312452021-05-08 14:32:59 +02003542 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3543 make test
3544}
3545
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003546component_test_psa_crypto_config_accel_hash_keep_builtins () {
3547 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3548 # This component ensures that all the test cases for
3549 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3550
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003551 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3552 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3553 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003554
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003555 # Start from default config (no TLS 1.3, no USE_PSA)
3556 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003557
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003558 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003559
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003560 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003561
3562 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3563 make test
3564}
3565
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003566# Auxiliary function to build config for hashes with and without drivers
3567config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003568 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003569 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003570 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003571 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003572 # disable the built-in implementation of hashes
3573 scripts/config.py unset MBEDTLS_MD5_C
3574 scripts/config.py unset MBEDTLS_RIPEMD160_C
3575 scripts/config.py unset MBEDTLS_SHA1_C
3576 scripts/config.py unset MBEDTLS_SHA224_C
3577 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003578 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003579 scripts/config.py unset MBEDTLS_SHA384_C
3580 scripts/config.py unset MBEDTLS_SHA512_C
3581 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003582 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003583 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003584}
3585
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003586# Note that component_test_psa_crypto_config_reference_hash_use_psa
3587# is related to this component and both components need to be kept in sync.
3588# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003589component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003590 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003591
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003592 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3593 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3594 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003595
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003596 # Configure
3597 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003598
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003599 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003600
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003601 # Build
3602 # -----
3603
3604 helper_libtestdriver1_make_drivers "$loc_accel_list"
3605
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003606 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003607
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003608 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003609 # 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 +02003610 not grep mbedtls_md5 library/md5.o
3611 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003612 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003613 not grep mbedtls_sha512 library/sha512.o
3614 not grep mbedtls_ripemd160 library/ripemd160.o
3615
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003616 # Run the tests
3617 # -------------
3618
Gilles Peskine14302ed2023-07-19 19:30:04 +02003619 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003620 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003621
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003622 # This is mostly useful so that we can later compare outcome files with
3623 # the reference config in analyze_outcomes.py, to check that the
3624 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003625 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003626 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003627
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003628 # This is to make sure all ciphersuites are exercised, but we don't need
3629 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003630 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003631 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003632}
3633
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003634# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3635# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3636# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3637# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003638component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003639 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003640
3641 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003642
Przemek Stekielab0451b2022-10-24 11:29:35 +02003643 make
3644
Gilles Peskine14302ed2023-07-19 19:30:04 +02003645 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003646 make test
3647
Gilles Peskine14302ed2023-07-19 19:30:04 +02003648 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003649 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003650}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003651
John Durkop4377bf72020-10-23 01:26:57 -07003652component_test_psa_crypto_config_accel_cipher () {
3653 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated cipher"
3654
Valerio Setti0244fbb2023-10-19 10:42:31 +02003655 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3656 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3657 KEY_TYPE_DES"
John Durkop1b7ee052020-11-27 08:51:22 -08003658
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003659 # Configure
3660 # ---------
John Durkop1b7ee052020-11-27 08:51:22 -08003661
Valerio Setti9a427302023-10-17 11:40:42 +02003662 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003663 helper_libtestdriver1_adjust_config "full"
John Durkop1b7ee052020-11-27 08:51:22 -08003664
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003665 # Disable the things that are being accelerated
John Durkop1b7ee052020-11-27 08:51:22 -08003666 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3667 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3668 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3669 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3670 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3671 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3672 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003673 scripts/config.py unset MBEDTLS_CMAC_C
John Durkop1b7ee052020-11-27 08:51:22 -08003674
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003675 # Build
3676 # -----
John Durkop1b7ee052020-11-27 08:51:22 -08003677
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003678 helper_libtestdriver1_make_drivers "$loc_accel_list"
3679
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003680 helper_libtestdriver1_make_main "$loc_accel_list"
John Durkop1b7ee052020-11-27 08:51:22 -08003681
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003682 # Make sure this was not re-enabled by accident (additive config)
John Durkop1b7ee052020-11-27 08:51:22 -08003683 not grep mbedtls_des* library/des.o
3684
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003685 # Run the tests
3686 # -------------
3687
John Durkop1b7ee052020-11-27 08:51:22 -08003688 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated cipher"
3689 make test
3690}
3691
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003692component_test_psa_crypto_config_accel_aead () {
3693 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3694
Valerio Setti3f02bb72023-10-02 15:57:33 +02003695 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3696 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003697
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003698 # Configure
3699 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003700
Valerio Setti3f02bb72023-10-02 15:57:33 +02003701 # Start from full config
3702 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003703
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003704 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003705 scripts/config.py unset MBEDTLS_GCM_C
3706 scripts/config.py unset MBEDTLS_CCM_C
3707 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003708
Valerio Settia50b89e2023-11-08 15:58:47 +01003709 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3710 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003711
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003712 # Build
3713 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003714
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003715 helper_libtestdriver1_make_drivers "$loc_accel_list"
3716
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003717 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003718
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003719 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003720 not grep mbedtls_ccm library/ccm.o
3721 not grep mbedtls_gcm library/gcm.o
3722 not grep mbedtls_chachapoly library/chachapoly.o
3723
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003724 # Run the tests
3725 # -------------
3726
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003727 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3728 make test
3729}
3730
Valerio Settib680fc42023-10-13 09:29:37 +02003731# This is a common configuration function used in:
3732# - component_test_psa_crypto_config_accel_cipher_aead
3733# - component_test_psa_crypto_config_reference_cipher_aead
3734common_psa_crypto_config_accel_cipher_aead() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003735 # Start from the full config
3736 helper_libtestdriver1_adjust_config "full"
3737
Valerio Settiec9b2582023-11-08 16:50:54 +01003738 # CIPHER_C is disabled in the accelerated test component so we disable
3739 # all the features that depend on it both in the accelerated and in the
3740 # reference components.
3741 scripts/config.py unset MBEDTLS_PKCS5_C
3742 scripts/config.py unset MBEDTLS_PKCS12_C
3743
Valerio Settib680fc42023-10-13 09:29:37 +02003744 scripts/config.py unset MBEDTLS_NIST_KW_C
3745}
3746
Valerio Settib6b301f2023-10-04 12:05:05 +02003747# The 2 following test components, i.e.
3748# - component_test_psa_crypto_config_accel_cipher_aead
3749# - component_test_psa_crypto_config_reference_cipher_aead
3750# are meant to be used together in analyze_outcomes.py script in order to test
3751# driver's coverage for ciphers and AEADs.
3752component_test_psa_crypto_config_accel_cipher_aead () {
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003753 msg "build: full config with accelerated cipher and AEAD"
Valerio Settib6b301f2023-10-04 12:05:05 +02003754
Valerio Settiad8b7f02023-10-25 12:39:50 +02003755 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 +01003756 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003757 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003758 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3759
3760 # Configure
3761 # ---------
3762
Valerio Settib680fc42023-10-13 09:29:37 +02003763 common_psa_crypto_config_accel_cipher_aead
Valerio Settib6b301f2023-10-04 12:05:05 +02003764
3765 # Disable the things that are being accelerated
3766 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3767 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3768 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3769 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3770 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3771 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3772 scripts/config.py unset MBEDTLS_GCM_C
3773 scripts/config.py unset MBEDTLS_CCM_C
3774 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003775 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003776 scripts/config.py unset MBEDTLS_DES_C
3777 scripts/config.py unset MBEDTLS_AES_C
3778 scripts/config.py unset MBEDTLS_ARIA_C
3779 scripts/config.py unset MBEDTLS_CHACHA20_C
3780 scripts/config.py unset MBEDTLS_CAMELLIA_C
3781
Valerio Settiec9b2582023-11-08 16:50:54 +01003782 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3783 # does not depend on it.
3784 scripts/config.py unset MBEDTLS_CIPHER_C
3785
Valerio Settib6b301f2023-10-04 12:05:05 +02003786 # Build
3787 # -----
3788
3789 helper_libtestdriver1_make_drivers "$loc_accel_list"
3790
3791 helper_libtestdriver1_make_main "$loc_accel_list"
3792
3793 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003794 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003795 not grep mbedtls_des library/des.o
3796 not grep mbedtls_aes library/aes.o
3797 not grep mbedtls_aria library/aria.o
3798 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003799 not grep mbedtls_ccm library/ccm.o
3800 not grep mbedtls_gcm library/gcm.o
3801 not grep mbedtls_chachapoly library/chachapoly.o
3802 not grep mbedtls_cmac library/cmac.o
3803
3804 # Run the tests
3805 # -------------
3806
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003807 msg "test: full config with accelerated cipher and AEAD"
Valerio Settib6b301f2023-10-04 12:05:05 +02003808 make test
Valerio Settif9414552023-11-09 10:43:20 +01003809
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003810 msg "ssl-opt: full config with accelerated cipher and AEAD"
Valerio Settif9414552023-11-09 10:43:20 +01003811 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003812
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003813 msg "compat.sh: full config with accelerated cipher and AEAD"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003814 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003815}
3816
3817component_test_psa_crypto_config_reference_cipher_aead () {
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003818 msg "build: full config with non-accelerated cipher and AEAD"
Valerio Settib680fc42023-10-13 09:29:37 +02003819 common_psa_crypto_config_accel_cipher_aead
Valerio Settib6b301f2023-10-04 12:05:05 +02003820
Valerio Settif9414552023-11-09 10:43:20 +01003821 make
3822
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003823 msg "test: full config with non-accelerated cipher and AEAD"
Valerio Settib6b301f2023-10-04 12:05:05 +02003824 make test
Valerio Settif9414552023-11-09 10:43:20 +01003825
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003826 msg "ssl-opt: full config with non-accelerated cipher and AEAD"
Valerio Settif9414552023-11-09 10:43:20 +01003827 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003828
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003829 msg "compat.sh: full config with non-accelerated cipher and AEAD"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003830 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003831}
3832
Gilles Peskine36dea152023-07-20 22:19:45 +02003833component_test_aead_chachapoly_disabled() {
3834 msg "build: full minus CHACHAPOLY"
John Durkopf4c4cb02020-10-28 20:09:55 -07003835 scripts/config.py full
John Durkop9814fa22020-11-04 12:28:15 -08003836 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02003837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Dave Rodgman17127e92023-12-14 16:42:48 +00003838 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
John Durkop6ba40d12020-11-10 08:50:04 -08003839
Gilles Peskine36dea152023-07-20 22:19:45 +02003840 msg "test: full minus CHACHAPOLY"
3841 make test
3842}
3843
3844component_test_aead_only_ccm() {
3845 msg "build: full minus CHACHAPOLY and GCM"
3846 scripts/config.py full
3847 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
3848 scripts/config.py unset MBEDTLS_GCM_C
3849 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
3850 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Dave Rodgman17127e92023-12-14 16:42:48 +00003851 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02003852
3853 msg "test: full minus CHACHAPOLY and GCM"
John Durkop9814fa22020-11-04 12:28:15 -08003854 make test
John Durkopf4c4cb02020-10-28 20:09:55 -07003855}
3856
Ronald Crone501d0e2023-07-10 08:31:19 +02003857component_test_ccm_aes_sha256() {
3858 msg "build: CCM + AES + SHA256 configuration"
3859
Ronald Cron7612d8c2023-07-20 10:03:54 +02003860 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02003861 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02003862
3863 make CC=gcc
3864
3865 msg "test: CCM + AES + SHA256 configuration"
3866 make test
3867}
3868
John Durkop9814fa22020-11-04 12:28:15 -08003869# 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 -07003870component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003871 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07003872 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07003873 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003874 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07003875 scripts/config.py unset MBEDTLS_ECDH_C
3876 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3877 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
3878 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3879 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3880 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
3881 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00003882 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07003883}
3884
John Durkop1b7ee052020-11-27 08:51:22 -08003885# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
3886component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003887 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkop1b7ee052020-11-27 08:51:22 -08003888 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003889 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003890 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003891 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00003892 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003893}
3894
3895# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
3896component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003897 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkop1b7ee052020-11-27 08:51:22 -08003898 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003899 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003900 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003901 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01003902 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
3903 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003904 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00003905 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003906}
3907
3908# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
3909component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003910 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003911 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003912 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003913 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003914 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3915 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3916 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3917 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3918 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3919 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3920 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003921 scripts/config.py unset MBEDTLS_LMS_C
3922 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003923 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00003924 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003925}
3926
3927# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
3928component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003929 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003930 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003931 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003932 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003933 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3934 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3935 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3936 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3937 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3938 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3939 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003940 scripts/config.py unset MBEDTLS_LMS_C
3941 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003942 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00003943 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003944}
3945
3946# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
3947component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003948 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003949 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003950 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003951 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003952 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3953 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3954 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3955 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3956 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3957 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3958 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003959 scripts/config.py unset MBEDTLS_LMS_C
3960 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003961 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00003962 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003963}
3964
3965# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
3966component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003967 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003968 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003969 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003970 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003971 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3972 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3973 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3974 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3975 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3976 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08003977 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00003978 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003979}
3980
3981# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
3982component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003983 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003984 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003985 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003986 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003987 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3988 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3989 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3990 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3991 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3992 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08003993 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00003994 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003995}
3996
3997# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
3998component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003999 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004000 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004001 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004002 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004003 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4004 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4005 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4006 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4007 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4008 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004009 scripts/config.py unset MBEDTLS_LMS_C
4010 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004011 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00004012 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004013}
4014
4015# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4016component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004017 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004018 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004019 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004020 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004021 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4022 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4023 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4024 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4025 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4026 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4027 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004028 scripts/config.py unset MBEDTLS_LMS_C
4029 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004030 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00004031 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004032}
4033
John Durkopd0321952020-10-29 21:37:36 -07004034# 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 -08004035component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004036 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 -07004037 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004038 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004039 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004040 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4041 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4042 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4043 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004044 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00004045 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004046}
4047
4048# 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 -08004049component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004050 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 -07004051 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004052 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004053 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004054 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4055 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4056 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4057 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004058 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00004059 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004060}
4061
4062# 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 -08004063component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004064 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 -07004065 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004066 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004067 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004068 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4069 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4070 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4071 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004072 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00004073 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004074}
4075
4076# 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 -08004077component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004078 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 -07004079 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004080 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004081 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004082 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4083 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4084 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4085 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004086 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00004087 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004088}
4089
4090# 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 -08004091component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004092 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 -07004093 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004094 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004095 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004096 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4097 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4098 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4099 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4100 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004101 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00004102 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004103}
4104
4105# 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 -08004106component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004107 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 -07004108 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004109 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004110 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004111 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4112 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004113 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Dave Rodgman17127e92023-12-14 16:42:48 +00004114 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004115}
4116
Dave Rodgmanc164c072023-06-28 09:43:23 +01004117
Dave Rodgman904c5892023-06-28 17:36:02 +01004118support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004119 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004120}
4121
Dave Rodgman904c5892023-06-28 17:36:02 +01004122component_build_tfm_armcc() {
4123 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004124 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004125
Dave Rodgman88651c42023-06-29 12:35:51 +01004126 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004127 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 +01004128}
4129
4130component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004131 # Check that the TF-M configuration can build cleanly with various
4132 # warning flags enabled. We don't build or run tests, since the
4133 # TF-M configuration needs a TF-M platform. A tweaked version of
4134 # the configuration that works on mainstream platforms is in
4135 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004136 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004137
Dave Rodgman88651c42023-06-29 12:35:51 +01004138 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004139 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 +01004140
Dave Rodgman904c5892023-06-28 17:36:02 +01004141 msg "build: TF-M config, gcc native build"
4142 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004143 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 +01004144}
4145
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004146# Test that the given .o file builds with all (valid) combinations of the given options.
4147#
4148# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4149#
4150# The validator function is the name of a function to validate the combination of options.
4151# It may be "" if all combinations are valid.
4152# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004153# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004154build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004155 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004156 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004157 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004158 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004159 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004160
Dave Rodgman42436102023-10-03 15:47:05 +01004161 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004162 for opt in "${options[@]}"; do
4163 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004164 done
4165
4166 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004167 cd $(dirname ${file})
4168 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004169
Dave Rodgman920343a2023-10-01 18:41:09 +01004170 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004171 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 +01004172
Dave Rodgman42436102023-10-03 15:47:05 +01004173 # Extract the command generated by the Makefile to build the target file.
4174 # This ensures that we have any include paths, macro definitions, etc
4175 # that may be applied by make.
4176 # 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 +01004177 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004178
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004179 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004180 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004181
Dave Rodgman28e38d82023-10-04 11:50:30 +01004182 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004183 source_file=${file%.o}.c
4184
4185 targets=0
4186 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004187
Dave Rodgman28e38d82023-10-04 11:50:30 +01004188 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004189 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004190 # each bit of $i is used to determine if options[i] will be set or not
4191 target="t"
4192 clang_args=""
4193 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004194 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004195 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004196 clang_args="${clang_args} ${opt}"
4197 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004198 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004199 done
4200
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004201 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004202 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004203 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004204 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004205
Dave Rodgman28e38d82023-10-04 11:50:30 +01004206 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004207 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004208 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004209 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004210
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004211 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004212
Dave Rodgman920343a2023-10-01 18:41:09 +01004213 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004214 make -s -f ${makefile} build_test_config_combos
4215 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004216
4217 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004218 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004219}
4220
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004221validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004222 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4223 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004224 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004225 fi
4226 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4227 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004228 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004229 fi
4230 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004231 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004232}
4233
4234component_build_aes_variations() {
4235 # 18s - around 90ms per clang invocation on M1 Pro
4236 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004237 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004238 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004239
Yanray Wangbc29aef2023-11-06 11:08:17 +08004240 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004241 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004242
Dave Rodgman42436102023-10-03 15:47:05 +01004243 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004244 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4245 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4246 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4247 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004248
4249 cd "$MBEDTLS_ROOT_DIR"
4250 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4251
Yanray Wang42be1ba2023-11-23 14:28:47 +08004252 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004253 # manually set or unset those configurations to check
4254 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004255 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4256 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4257 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4258 scripts/config.py unset MBEDTLS_DES_C
4259 scripts/config.py unset MBEDTLS_NIST_KW_C
4260 build_test_config_combos library/aes.o validate_aes_config_variations \
4261 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4262 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4263 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4264 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004265}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004266
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004267component_test_no_platform () {
4268 # Full configuration build, without platform support, file IO and net sockets.
4269 # This should catch missing mbedtls_printf definitions, and by disabling file
4270 # IO, it should catch missing '#include <stdio.h>'
4271 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004272 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004273 scripts/config.py unset MBEDTLS_PLATFORM_C
4274 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004275 scripts/config.py unset MBEDTLS_FS_IO
4276 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004277 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004278 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004279 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004280 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004281 # to re-enable platform integration features otherwise disabled in C99 builds
4282 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Simon Butchercb587002017-01-06 16:14:44 +00004283 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
4284}
Gilles Peskine7c652162017-12-11 00:01:40 +01004285
4286component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004287 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004288 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4289 scripts/config.py full
4290 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004291 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4292 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4293 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4294 make
4295}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004296
Gilles Peskine8f073122018-11-27 15:58:47 +01004297component_build_no_ssl_srv () {
4298 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004299 scripts/config.py full
4300 scripts/config.py unset MBEDTLS_SSL_SRV_C
4301 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
4302}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004303
Gilles Peskine8f073122018-11-27 15:58:47 +01004304component_build_no_ssl_cli () {
4305 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004306 scripts/config.py full
4307 scripts/config.py unset MBEDTLS_SSL_CLI_C
4308 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
4309}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004310
Gilles Peskine8f073122018-11-27 15:58:47 +01004311component_build_no_sockets () {
4312 # Note, C99 compliance can also be tested with the sockets support disabled,
4313 # as that requires a POSIX platform (which isn't the same as C99).
4314 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004315 scripts/config.py full
4316 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4317 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4318 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4319}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004320
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004321component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004322 msg "build: default config with memory buffer allocator and backtrace enabled"
4323 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4324 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4325 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004326 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4327 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
4328 make
4329
4330 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4331 make test
4332}
4333
4334component_test_memory_buffer_allocator () {
4335 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004336 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4337 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004338 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004339 make
4340
4341 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4342 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004343
4344 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4345 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004346 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004347}
4348
Gilles Peskine8f073122018-11-27 15:58:47 +01004349component_test_no_max_fragment_length () {
4350 # Run max fragment length tests with MFL disabled
4351 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004352 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004353 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004354 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004355
Gilles Peskine8f073122018-11-27 15:58:47 +01004356 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004357 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004358}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004359
Hanno Becker545ced42019-02-19 11:10:48 +00004360component_test_asan_remove_peer_certificate () {
4361 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004362 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Dave Rodgman17127e92023-12-14 16:42:48 +00004363 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004364 make
4365
4366 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4367 make test
4368
4369 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004370 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004371
4372 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004373 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004374
4375 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004376 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004377}
4378
Gilles Peskine8f073122018-11-27 15:58:47 +01004379component_test_no_max_fragment_length_small_ssl_out_content_len () {
4380 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004381 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4382 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4383 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004384 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004385 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004386
Gilles Peskine8f073122018-11-27 15:58:47 +01004387 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004388 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004389
4390 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004391 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004392}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004393
Darryl Greenaad82f92019-12-02 10:53:11 +00004394component_test_variable_ssl_in_out_buffer_len () {
4395 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4396 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004397 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004398 make
4399
4400 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4401 make test
4402
4403 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004404 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004405
4406 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004407 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004408}
4409
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004410component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004411 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004412 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004413
Dave Rodgman17127e92023-12-14 16:42:48 +00004414 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004415 make
4416
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004417 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004418 make test
4419
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004420 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004421 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004422
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004423 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004424 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004425}
4426
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004427component_test_ssl_alloc_buffer_and_mfl () {
4428 msg "build: default config with memory buffer allocator and MFL extension"
4429 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4430 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4431 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4432 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4433 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004434 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004435 make
4436
4437 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4438 make test
4439
4440 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 +02004441 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004442}
4443
Gilles Peskine636c26a2020-03-04 20:46:15 +01004444component_test_when_no_ciphersuites_have_mac () {
4445 msg "build: when no ciphersuites have MAC"
4446 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004447 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004448 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004449 make
4450
4451 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4452 make test
4453
4454 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004455 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004456}
4457
Raoul Strackxa4e86142020-06-15 17:03:13 +02004458component_test_no_date_time () {
4459 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4460 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004461 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004462 make
4463
4464 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4465 make test
4466}
4467
Gilles Peskine8f073122018-11-27 15:58:47 +01004468component_test_platform_calloc_macro () {
4469 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004470 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4471 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4472 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004473 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004474 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004475
Gilles Peskine8f073122018-11-27 15:58:47 +01004476 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4477 make test
4478}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004479
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004480component_test_malloc_0_null () {
4481 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004482 scripts/config.py full
Dave Rodgman17127e92023-12-14 16:42:48 +00004483 make CC=$ASAN_CC CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"$PWD/tests/configs/user-config-malloc-0-null.h\"' $ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004484
4485 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4486 make test
4487
4488 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4489 # Just the calloc selftest. "make test" ran the others as part of the
4490 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004491 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004492
4493 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4494 # Run a subset of the tests. The choice is a balance between coverage
4495 # and time (including time indirectly wasted due to flaky tests).
4496 # The current choice is to skip tests whose description includes
4497 # "proxy", which is an approximation of skipping tests that use the
4498 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004499 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004500}
4501
Dave Rodgman6a08b682023-06-19 11:51:33 +01004502support_test_aesni() {
4503 # Check that gcc targets x86_64 (we can build AESNI), and check for
4504 # AESNI support on the host (we can run AESNI).
4505 #
4506 # The name of this function is possibly slightly misleading, but needs to align
4507 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004508 #
4509 # In principle 32-bit x86 can support AESNI, but our implementation does not
4510 # support 32-bit x86, so we check for x86-64.
4511 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004512 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4513 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004514 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004515}
4516
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004517component_test_aesni () { # ~ 60s
4518 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4519 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4520 #
4521 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4522 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4523 # exercise the plain C impl).
4524
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004525 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004526 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004527 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004528 scripts/config.py set MBEDTLS_HAVE_ASM
4529
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004530 # test the intrinsics implementation
4531 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004532 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004533 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004534 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004535 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004536
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004537 # test the asm implementation
4538 msg "AES tests, test assembly"
4539 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004540 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004541 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004542 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004543
4544 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004545 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004546 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004547 msg "AES tests, plain C"
4548 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004549 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004550 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004551 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004552 not grep -q "AES note: using AESNI" ./programs/test/selftest
4553 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004554
4555 # test the intrinsics implementation
4556 scripts/config.py set MBEDTLS_AESNI_C
4557 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4558 msg "AES tests, test AESNI only"
4559 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004560 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004561 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4562 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004563 grep -q "AES note: using AESNI" ./programs/test/selftest
4564 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004565}
4566
Jerry Yub6d39c22023-08-16 15:11:48 +08004567support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004568 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004569}
4570
4571component_test_aesni_m32 () { # ~ 60s
4572 # This tests are duplicated from component_test_aesni for i386 target
4573 #
4574 # AESNI intrinsic code supports i386 and assembly code does not support it.
4575
4576 msg "build: default config with different AES implementations"
4577 scripts/config.py set MBEDTLS_AESNI_C
4578 scripts/config.py set MBEDTLS_PADLOCK_C
4579 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4580 scripts/config.py set MBEDTLS_HAVE_ASM
4581
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004582 # test the intrinsics implementation with gcc
4583 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004584 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004585 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004586 # check that we built intrinsics - this should be used by default when supported by the compiler
4587 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4588 grep -q "AES note: using AESNI" ./programs/test/selftest
4589 grep -q "AES note: built-in implementation." ./programs/test/selftest
4590 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4591 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4592
4593 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004594 scripts/config.py unset MBEDTLS_PADLOCK_C
4595 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4596 msg "AES tests, test AESNI only"
4597 make clean
4598 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4599 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4600 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4601 grep -q "AES note: using AESNI" ./programs/test/selftest
4602 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4603 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4604 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4605}
4606
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004607support_test_aesni_m32_clang() {
4608 support_test_aesni_m32 && if command -v clang > /dev/null ; then
4609 # clang >= 4 is required to build with target attributes
4610 clang_ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
4611 [[ "${clang_ver}" -ge 4 ]]
4612 else
4613 # clang not available
4614 false
4615 fi
4616}
4617
4618component_test_aesni_m32_clang() {
4619
4620 scripts/config.py set MBEDTLS_AESNI_C
4621 scripts/config.py set MBEDTLS_PADLOCK_C
4622 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4623 scripts/config.py set MBEDTLS_HAVE_ASM
4624
4625 # test the intrinsics implementation with clang
4626 msg "AES tests, test intrinsics (clang)"
4627 make clean
4628 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4629 # check that we built intrinsics - this should be used by default when supported by the compiler
4630 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4631 grep -q "AES note: using AESNI" ./programs/test/selftest
4632 grep -q "AES note: built-in implementation." ./programs/test/selftest
4633 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4634 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4635}
4636
Jerry Yu193cbc02023-08-03 17:06:29 +08004637# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4638component_build_aes_aesce_armcc () {
4639 msg "Build: AESCE test on arm64 platform without plain C."
4640 scripts/config.py baremetal
4641
4642 # armc[56] don't support SHA-512 intrinsics
4643 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4644
4645 # Stop armclang warning about feature detection for A64_CRYPTO.
4646 # With this enabled, the library does build correctly under armclang,
4647 # but in baremetal builds (as tested here), feature detection is
4648 # unavailable, and the user is notified via a #warning. So enabling
4649 # this feature would prevent us from building with -Werror on
4650 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004651 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004652 scripts/config.py set MBEDTLS_HAVE_ASM
4653
4654 msg "AESCE, build with default configuration."
4655 scripts/config.py set MBEDTLS_AESCE_C
4656 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4657 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4658
4659 msg "AESCE, build AESCE only"
4660 scripts/config.py set MBEDTLS_AESCE_C
4661 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4662 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4663}
4664
Dave Rodgman0c584032023-10-08 12:26:54 +01004665support_build_aes_armce() {
4666 # clang >= 4 is required to build with AES extensions
4667 ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
Dave Rodgman48b965d2023-10-09 12:19:44 +01004668 [ "${ver}" -ge 11 ]
Dave Rodgman0c584032023-10-08 12:26:54 +01004669}
4670
4671component_build_aes_armce () {
4672 # Test variations of AES with Armv8 crypto extensions
4673 scripts/config.py set MBEDTLS_AESCE_C
4674 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4675
4676 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004677 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004678
4679 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4680 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4681
4682 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4683 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4684
Dave Rodgman5e419372023-10-23 15:30:20 +01004685 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004686
Dave Rodgman5e419372023-10-23 15:30:20 +01004687 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4688 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004689
Dave Rodgman5e419372023-10-23 15:30:20 +01004690 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4691 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004692
Dave Rodgman5e419372023-10-23 15:30:20 +01004693 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4694 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004695
4696 # test for presence of AES instructions
4697 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4698 msg "clang, test A32 crypto instructions built"
4699 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4700 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4701 msg "clang, test T32 crypto instructions built"
4702 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4703 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4704 msg "clang, test aarch64 crypto instructions built"
4705 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4706 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4707
4708 # test for absence of AES instructions
4709 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4710 scripts/config.py unset MBEDTLS_AESCE_C
4711 msg "clang, test A32 crypto instructions not built"
4712 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4713 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4714 msg "clang, test T32 crypto instructions not built"
4715 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4716 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4717 msg "clang, test aarch64 crypto instructions not built"
4718 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4719 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004720}
4721
Dave Rodgman9ed18532023-10-05 00:06:47 +01004722support_build_sha_armce() {
Dave Rodgmanf2ea08a2023-10-16 11:37:28 +01004723 if command -v clang > /dev/null ; then
Dave Rodgmand35b1882023-10-16 10:25:30 +01004724 # clang >= 4 is required to build with SHA extensions
4725 clang_ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
Dave Rodgmanab0cff52023-10-13 09:32:04 +01004726
Dave Rodgman66d55122023-10-23 15:12:32 +01004727 [[ "${clang_ver}" -ge 4 ]]
Dave Rodgmand35b1882023-10-16 10:25:30 +01004728 else
4729 # clang not available
4730 false
4731 fi
Dave Rodgman9ed18532023-10-05 00:06:47 +01004732}
4733
Dave Rodgmand9e80832023-10-04 17:17:46 +01004734component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004735 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004736
4737
4738 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004739 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004740 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4741 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4742 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4743 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4744 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004745
Dave Rodgmand9e80832023-10-04 17:17:46 +01004746
Dave Rodgman94a634d2023-10-10 12:59:29 +01004747 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004748 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004749 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4750 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4751 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004752
Dave Rodgman5b89c552023-10-10 14:59:02 +01004753 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004754 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4755 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4756 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004757
Dave Rodgmancd654002023-10-05 09:40:07 +01004758
Dave Rodgman94a634d2023-10-10 12:59:29 +01004759 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004760 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004761 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4762 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4763 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4764 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4765 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004766
Dave Rodgmancd654002023-10-05 09:40:07 +01004767
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004768 # examine the disassembly for presence of SHA instructions
4769 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4770 scripts/config.py set ${opt}
4771 msg "${opt} clang, test A32 crypto instructions built"
4772 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4773 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4774
4775 msg "${opt} clang, test T32 crypto instructions built"
4776 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4777 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4778
4779 msg "${opt} clang, test aarch64 crypto instructions built"
4780 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4781 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4782 scripts/config.py unset ${opt}
4783 done
4784
4785
4786 # examine the disassembly for absence of SHA instructions
4787 msg "clang, test A32 crypto instructions not built"
4788 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4789 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4790
4791 msg "clang, test T32 crypto instructions not built"
4792 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4793 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4794
4795 msg "clang, test aarch64 crypto instructions not built"
4796 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4797 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004798}
4799
Jerry Yuc935aa62023-08-03 17:08:27 +08004800# For timebeing, no VIA Padlock platform available.
4801component_build_aes_via_padlock () {
4802
4803 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004804 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004805 scripts/config.py set MBEDTLS_PADLOCK_C
4806 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004807 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004808 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004809
4810}
4811
4812support_build_aes_via_padlock_only () {
4813 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4814 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4815 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4816}
4817
Jerry Yu193cbc02023-08-03 17:06:29 +08004818support_build_aes_aesce_armcc () {
4819 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004820}
4821
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004822component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004823 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004824 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004825 scripts/config.py unset MBEDTLS_PADLOCK_C
4826
4827 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004828
Gilles Peskine8f073122018-11-27 15:58:47 +01004829 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4830 make test
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004831}
4832
Gilles Peskine8f073122018-11-27 15:58:47 +01004833component_test_no_ctr_drbg_aes_only_128_bit_keys () {
Hanno Becker83ebf782017-07-07 12:29:15 +01004834 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine8f073122018-11-27 15:58:47 +01004835 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4836 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4837 scripts/config.py unset MBEDTLS_PADLOCK_C
4838
Gilles Peskine592f5912019-10-07 18:49:32 +02004839 make CC=clang CFLAGS='-Werror -Wall -Wextra'
4840
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004841 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4842 make test
4843}
Gilles Peskine592f5912019-10-07 18:49:32 +02004844
4845component_test_aes_only_128_bit_keys_have_builtins () {
4846 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4847 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4848 scripts/config.py unset MBEDTLS_PADLOCK_C
4849 scripts/config.py unset MBEDTLS_AESNI_C
4850 scripts/config.py unset MBEDTLS_AESCE_C
4851
4852 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004853
4854 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4855 make test
Gilles Peskine592f5912019-10-07 18:49:32 +02004856
4857 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4858 programs/test/selftest
4859}
4860
4861component_test_aes_fewer_tables () {
4862 msg "build: default config with AES_FEWER_TABLES enabled"
4863 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4864 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004865
4866 msg "test: AES_FEWER_TABLES"
4867 make test
4868}
Gilles Peskine592f5912019-10-07 18:49:32 +02004869
4870component_test_aes_rom_tables () {
4871 msg "build: default config with AES_ROM_TABLES enabled"
4872 scripts/config.py set MBEDTLS_AES_ROM_TABLES
4873 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
4874
4875 msg "test: AES_ROM_TABLES"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004876 make test
4877}
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004878
Gilles Peskine004206c2019-10-21 17:11:33 +02004879component_test_aes_fewer_tables_and_rom_tables () {
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004880 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4881 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4882 scripts/config.py set MBEDTLS_AES_ROM_TABLES
4883 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
4884
Steven Cooremand57203d2020-07-16 20:28:59 +02004885 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
Ronald Cron32a432a2023-03-28 09:19:04 +02004886 make test
Steven Cooreman753f9732021-03-15 11:38:44 +01004887}
Steven Cooreman6801f082021-02-19 17:21:22 +01004888
Yanray Wang49cd4b52023-11-10 11:58:37 +08004889# helper for common_block_cipher_no_decrypt() which:
4890# - enable/disable the list of config options passed from -s/-u respectively.
4891# - build
4892# - test for tests_suite_xxx
4893# - selftest
4894#
4895# Usage: helper_block_cipher_no_decrypt_build_test
4896# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4897# Options: -s set_opts the list of config options to enable
4898# -u unset_opts the list of config options to disable
4899# -c cflags the list of options passed to CFLAGS
4900# -l ldflags the list of options passed to LDFLAGS
4901helper_block_cipher_no_decrypt_build_test () {
4902 while [ $# -gt 0 ]; do
4903 case "$1" in
4904 -s)
4905 shift; local set_opts="$1";;
4906 -u)
4907 shift; local unset_opts="$1";;
4908 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004909 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004910 -l)
4911 shift; local ldflags="$1";;
4912 esac
4913 shift
4914 done
4915 set_opts="${set_opts:-}"
4916 unset_opts="${unset_opts:-}"
4917 cflags="${cflags:-}"
4918 ldflags="${ldflags:-}"
4919
Yanray Wangb2d6e522023-11-13 16:57:47 +08004920 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4921 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004922
4923 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4924 make clean
4925 make CC=gcc CFLAGS="$cflags" LDFLAGS="$ldflags"
4926
4927 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4928 not grep mbedtls_aes_setkey_dec library/aes.o
4929 not grep mbedtls_aria_setkey_dec library/aria.o
4930 not grep mbedtls_camellia_setkey_dec library/camellia.o
4931 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4932 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004933 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4934 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004935
4936 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4937 make test
4938
4939 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4940 programs/test/selftest
4941}
4942
4943# This is a common configuration function used in:
4944# - component_test_block_cipher_no_decrypt_aesni_legacy()
4945# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4946# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4947# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4948# on x86.
4949common_block_cipher_no_decrypt () {
4950 # test AESNI intrinsics
4951 helper_block_cipher_no_decrypt_build_test \
4952 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004953 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004954
4955 # test AESNI assembly
4956 helper_block_cipher_no_decrypt_build_test \
4957 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004958 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004959
4960 # test AES C implementation
4961 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004962 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004963
4964 # test AESNI intrinsics for i386 target
4965 helper_block_cipher_no_decrypt_build_test \
4966 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004967 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004968 -l "-m32"
4969}
4970
Yanray Wang3ae11992023-11-13 17:32:09 +08004971# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4972# usage: 0: no PSA crypto configuration
4973# 1: use PSA crypto configuration
4974config_block_cipher_no_decrypt () {
4975 use_psa=$1
4976
Yanray Wang66111392023-10-31 18:54:54 +08004977 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004978 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4979 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004980 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004981 scripts/config.py unset MBEDTLS_NIST_KW_C
4982
Yanray Wang3ae11992023-11-13 17:32:09 +08004983 if [ "$use_psa" -eq 1 ]; then
4984 # Enable support for cryptographic mechanisms through the PSA API.
4985 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4986 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4987 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4988 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4989 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4990 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4991 fi
4992}
4993
4994component_test_block_cipher_no_decrypt_aesni () {
4995 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004996 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004997}
4998
Yanray Wangf1496402023-11-01 18:55:13 +08004999component_test_block_cipher_no_decrypt_aesni_use_psa () {
Yanray Wang3ae11992023-11-13 17:32:09 +08005000 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005001 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005002}
5003
Yanray Wang66111392023-10-31 18:54:54 +08005004support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005005 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005006}
5007
Yanray Wang66111392023-10-31 18:54:54 +08005008component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005009 scripts/config.py baremetal
5010
5011 # armc[56] don't support SHA-512 intrinsics
5012 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5013
5014 # Stop armclang warning about feature detection for A64_CRYPTO.
5015 # With this enabled, the library does build correctly under armclang,
5016 # but in baremetal builds (as tested here), feature detection is
5017 # unavailable, and the user is notified via a #warning. So enabling
5018 # this feature would prevent us from building with -Werror on
5019 # armclang. Tracked in #7198.
5020 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5021 scripts/config.py set MBEDTLS_HAVE_ASM
5022
Yanray Wang3ae11992023-11-13 17:32:09 +08005023 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005024
5025 # test AESCE baremetal build
5026 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005027 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005028 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005029
Yanray Wangef1b04d2023-09-08 11:09:26 +08005030 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5031 not grep mbedtls_aes_setkey_dec library/aes.o
5032 not grep mbedtls_aria_setkey_dec library/aria.o
5033 not grep mbedtls_camellia_setkey_dec library/camellia.o
5034 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5035 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005036 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005037 not grep mbedtls_aesce_inverse_key library/aesce.o
5038 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005039}
5040
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005041component_test_ctr_drbg_aes_256_sha_256 () {
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005042 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5043 scripts/config.py full
5044 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5045 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005046 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005047 make
5048
5049 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5050 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005051}
5052
Gilles Peskine14c3c062018-01-29 21:25:12 +01005053component_test_ctr_drbg_aes_128_sha_512 () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005054 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5055 scripts/config.py full
5056 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5057 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005058 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005059 make
5060
5061 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5062 make test
5063}
5064
5065component_test_ctr_drbg_aes_128_sha_256 () {
5066 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005067 scripts/config.py full
5068 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5069 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5070 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005071 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005072 make
5073
Gilles Peskine8f073122018-11-27 15:58:47 +01005074 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5075 make test
5076}
5077
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005078component_test_se_default () {
5079 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5080 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
5081 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
5082
5083 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5084 make test
5085}
5086
Steven Cooremand57203d2020-07-16 20:28:59 +02005087component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005088 msg "build: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005089 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005090 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005091 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5092 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005093 loc_cflags="${loc_cflags} -I../tests/include -O2"
5094
Dave Rodgman17127e92023-12-14 16:42:48 +00005095 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005096
Gilles Peskine1997f302023-07-26 18:45:20 +02005097 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005098 make test
5099}
5100
Gilles Peskine8f073122018-11-27 15:58:47 +01005101component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005102 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005103 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005104 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005105 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005106}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005107
Gilles Peskinecf740502019-07-03 20:43:05 +02005108component_test_cmake_shared () {
5109 msg "build/test: cmake shared" # ~ 2min
5110 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5111 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005112 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005113 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005114 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005115}
5116
Gilles Peskineec10bf12019-09-20 19:56:06 +02005117test_build_opt () {
5118 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005119 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005120 for opt in "$@"; do
5121 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskinee094a182020-04-14 20:08:41 +02005122 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005123 # We're confident enough in compilers to not run _all_ the tests,
5124 # but at least run the unit tests. In particular, runs with
5125 # optimizations use inline assembly whereas runs with -O0
5126 # skip inline assembly.
5127 make test # ~30s
5128 make clean
5129 done
5130}
5131
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005132# For FreeBSD we invoke the function by name so this condition is added
5133# to disable the existing test_clang_opt function for linux.
5134if [[ $(uname) != "Linux" ]]; then
5135 component_test_clang_opt () {
5136 scripts/config.py full
5137 test_build_opt 'full config' clang -O0 -Os -O2
5138 }
5139fi
5140
5141component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005142 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005143 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005144}
5145support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005146 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005147}
5148
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005149component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005150 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005151 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005152}
5153support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005154 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005155}
5156
5157component_test_gcc_latest_opt () {
5158 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005159 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005160}
5161support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005162 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005163}
5164
5165component_test_gcc_earliest_opt () {
5166 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005167 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005168}
5169support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005170 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005171}
5172
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005173component_build_mbedtls_config_file () {
5174 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005175 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005176 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
5177 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005178 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005179 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5180 make clean
5181
5182 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5183 # In the user config, disable one feature (for simplicity, pick a feature
5184 # that nothing else depends on).
5185 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5186 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
5187 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5188
5189 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005190}
5191
Gilles Peskine7d904e72022-04-07 21:59:14 +02005192component_build_psa_config_file () {
5193 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5194 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5195 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5196 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5197 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005198 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005199 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5200 make clean
5201
5202 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5203 # In the user config, disable one feature, which will reflect on the
5204 # mbedtls configuration so we can query it with query_compile_time_config.
5205 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5206 scripts/config.py unset MBEDTLS_CMAC_C
5207 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5208 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5209
5210 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005211}
5212
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005213component_build_psa_alt_headers () {
5214 msg "build: make with PSA alt headers" # ~20s
5215
5216 # Generate alternative versions of the substitutable headers with the
5217 # same content except different include guards.
5218 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5219
5220 # Build the library and some programs.
5221 # Don't build the fuzzers to avoid having to go through hoops to set
5222 # a correct include path for programs/fuzz/Makefile.
5223 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
5224 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\"'"
5225
5226 # Check that we're getting the alternative include guards and not the
5227 # original include guards.
5228 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5229 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5230 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5231 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5232}
5233
Dave Rodgman852de3c2023-12-14 14:46:45 +00005234component_test_m32_no_asm () {
5235 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005236 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005237 #
5238 # Note that we require gcc, because clang Asan builds fail to link for
5239 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005240 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005241 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005242 scripts/config.py unset MBEDTLS_HAVE_ASM
5243 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005244 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgman852de3c2023-12-14 14:46:45 +00005245 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005246
Dave Rodgman852de3c2023-12-14 14:46:45 +00005247 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005248 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005249}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005250support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005251 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005252 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005253 *) false;;
5254 esac
5255}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005256
Gilles Peskineff0aee02021-10-05 09:36:03 +02005257component_test_m32_o2 () {
5258 # Build with optimization, to use the i386 specific inline assembly
5259 # and go faster for tests.
5260 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005261 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005262 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmana19c7532023-12-14 14:42:42 +00005263 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005264
Gilles Peskineff0aee02021-10-05 09:36:03 +02005265 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005266 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005267
Gilles Peskineff0aee02021-10-05 09:36:03 +02005268 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005269 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005270}
Gilles Peskinecf522222021-10-07 19:25:29 +02005271support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005272 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005273}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005274
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005275component_test_m32_everest () {
5276 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005277 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005278 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005279 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005280
5281 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5282 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005283
5284 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005285 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005286
5287 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5288 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005289 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005290}
5291support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005292 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005293}
5294
Gilles Peskine8f073122018-11-27 15:58:47 +01005295component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005296 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005297 scripts/config.py full
Gilles Peskine5d26e7c2019-06-07 14:50:09 +02005298 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005299
5300 msg "test: 64-bit ILP32, make, gcc"
5301 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005302}
Gilles Peskine878cf602019-01-06 20:50:38 +00005303support_test_mx32 () {
5304 case $(uname -m) in
5305 amd64|x86_64) true;;
5306 *) false;;
5307 esac
5308}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005309
Peter Kolbus60c6da22018-12-27 06:59:04 -06005310component_test_min_mpi_window_size () {
5311 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005312 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005313 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005314 make
5315
5316 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5317 make test
5318}
5319
Gilles Peskine8f073122018-11-27 15:58:47 +01005320component_test_have_int32 () {
5321 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005322 scripts/config.py unset MBEDTLS_HAVE_ASM
5323 scripts/config.py unset MBEDTLS_AESNI_C
5324 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005325 scripts/config.py unset MBEDTLS_AESCE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01005326 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005327
Gilles Peskine8f073122018-11-27 15:58:47 +01005328 msg "test: gcc, force 32-bit bignum limbs"
5329 make test
5330}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005331
Gilles Peskine8f073122018-11-27 15:58:47 +01005332component_test_have_int64 () {
5333 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005334 scripts/config.py unset MBEDTLS_HAVE_ASM
5335 scripts/config.py unset MBEDTLS_AESNI_C
5336 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005337 scripts/config.py unset MBEDTLS_AESCE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01005338 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005339
Gilles Peskine8f073122018-11-27 15:58:47 +01005340 msg "test: gcc, force 64-bit bignum limbs"
5341 make test
5342}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005343
Gabor Mezeie256cc12023-07-26 17:28:48 +02005344component_test_have_int32_cmake_new_bignum () {
5345 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5346 scripts/config.py unset MBEDTLS_HAVE_ASM
5347 scripts/config.py unset MBEDTLS_AESNI_C
5348 scripts/config.py unset MBEDTLS_PADLOCK_C
5349 scripts/config.py unset MBEDTLS_AESCE_C
5350 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005351 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005352 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005353
5354 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5355 make test
5356}
5357
Gilles Peskine8f073122018-11-27 15:58:47 +01005358component_test_no_udbl_division () {
5359 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005360 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005361 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine8f073122018-11-27 15:58:47 +01005362 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005363
Gilles Peskine8f073122018-11-27 15:58:47 +01005364 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5365 make test
5366}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005367
Gilles Peskine8f073122018-11-27 15:58:47 +01005368component_test_no_64bit_multiplication () {
5369 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005370 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005371 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine8f073122018-11-27 15:58:47 +01005372 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005373
Gilles Peskine8f073122018-11-27 15:58:47 +01005374 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5375 make test
5376}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005377
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005378component_test_no_strings () {
5379 msg "build: no strings" # ~10s
5380 scripts/config.py full
5381 # Disable options that activate a large amount of string constants.
5382 scripts/config.py unset MBEDTLS_DEBUG_C
5383 scripts/config.py unset MBEDTLS_ERROR_C
5384 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5385 scripts/config.py unset MBEDTLS_VERSION_FEATURES
5386 make CFLAGS='-Werror -Os'
5387
5388 msg "test: no strings" # ~ 10s
5389 make test
5390}
5391
Hanno Beckerc5722d12020-10-09 11:10:42 +01005392component_test_no_x509_info () {
5393 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5394 scripts/config.pl full
5395 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5396 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskineff0aee02021-10-05 09:36:03 +02005397 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005398
5399 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5400 make test
5401
5402 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005403 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005404}
5405
Gilles Peskine8f073122018-11-27 15:58:47 +01005406component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005407 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005408 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005409 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 +02005410
Gilles Peskinee36fe812021-09-01 20:00:33 +02005411 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005412 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005413}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005414
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005415component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005416 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005417 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005418 # Build for a target platform that's close to what Debian uses
5419 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005420 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005421 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005422 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005423 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'
5424
Gilles Peskinee36fe812021-09-01 20:00:33 +02005425 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005426 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005427}
5428support_build_arm_linux_gnueabi_gcc_arm5vte () {
5429 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5430}
5431
5432component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005433 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005434 scripts/config.py baremetal
5435 # This is an imperfect substitute for
5436 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005437 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005438 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 +02005439
Gilles Peskinee36fe812021-09-01 20:00:33 +02005440 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005441 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005442}
5443
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005444component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005445 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5446 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005447 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 +02005448
Gilles Peskinee36fe812021-09-01 20:00:33 +02005449 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005450 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005451 for lib in library/*.a; do
5452 echo "$lib:"
5453 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5454 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005455}
5456
Gilles Peskine8f073122018-11-27 15:58:47 +01005457component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005458 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005459 scripts/config.py baremetal
5460 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
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 -Wall -Wextra' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01005462 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005463 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005464}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005465
Gilles Peskine8f073122018-11-27 15:58:47 +01005466component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005467 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005468 scripts/config.py baremetal
5469 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005470 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 +01005471 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005472 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005473}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005474
Dave Rodgman8c315f22023-06-02 10:26:24 -04005475component_build_arm_clang_thumb () {
5476 # ~ 30s
5477
5478 scripts/config.py baremetal
5479
5480 msg "build: clang thumb 2, make"
5481 make clean
5482 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5483
5484 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5485 msg "build: clang thumb 1 -O0, make"
5486 make clean
5487 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5488
5489 msg "build: clang thumb 1 -Os, make"
5490 make clean
5491 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5492}
5493
Gilles Peskine8f073122018-11-27 15:58:47 +01005494component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005495 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005496 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005497 # armc[56] don't support SHA-512 intrinsics
5498 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005499
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005500 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5501 scripts/config.py unset MBEDTLS_AESCE_C
5502
Dave Rodgman0fddf822023-03-02 15:32:12 +00005503 # Stop armclang warning about feature detection for A64_CRYPTO.
5504 # With this enabled, the library does build correctly under armclang,
5505 # but in baremetal builds (as tested here), feature detection is
5506 # unavailable, and the user is notified via a #warning. So enabling
5507 # this feature would prevent us from building with -Werror on
5508 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005509 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005510
Hanno Beckerf0762e92022-07-15 12:08:19 +01005511 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005512
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005513 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005514
5515 msg "size: ARM Compiler 5"
5516 "$ARMC5_FROMELF" -z library/*.o
5517
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005518 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005519
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005520 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005521 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005522
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005523 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005524 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5525
5526 # ARM Compiler 6 - Target ARMv7-M+DSP
5527 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005528
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005529 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005530 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005531
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005532 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005533 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005534
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005535 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5536 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5537
Dave Rodgman99318e62023-05-24 12:27:42 +01005538 # ARM Compiler 6 - Target Cortex-M0
5539 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005540
5541 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5542 #
5543 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5544 # that we have in our CI
5545 scripts/config.py set MBEDTLS_AESCE_C
5546 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005547}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005548
Pengyu Lvdf070032023-02-24 16:03:31 +08005549support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005550 armc5_cc="$ARMC5_BIN_DIR/armcc"
5551 armc6_cc="$ARMC6_BIN_DIR/armclang"
5552 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005553}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005554
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005555component_test_tls13_only () {
5556 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3, without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005557 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Jerry Yuda5af222021-12-24 18:45:45 +08005558 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5559
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005560 msg "test: TLS 1.3 only, all key exchange modes enabled"
5561 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005562
Ronald Cronc3f43b62022-10-17 17:35:32 +02005563 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5564 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005565}
5566
Ronald Cronc3f43b62022-10-17 17:35:32 +02005567component_test_tls13_only_psk () {
5568 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5569 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5570 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5571 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005572 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005573 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5574 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5575 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5576 scripts/config.py unset MBEDTLS_ECDSA_C
5577 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005578 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005579 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005580 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5581
Ronald Cronc3f43b62022-10-17 17:35:32 +02005582 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5583 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005584
Ronald Cronc3f43b62022-10-17 17:35:32 +02005585 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5586 tests/ssl-opt.sh
5587}
5588
5589component_test_tls13_only_ephemeral () {
5590 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5591 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5592 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005593 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005594 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5595
5596 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5597 cd tests; ./test_suite_ssl; cd ..
5598
5599 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5600 tests/ssl-opt.sh
5601}
5602
Przemek Stekiela01c2422023-06-13 10:46:48 +02005603component_test_tls13_only_ephemeral_ffdh () {
5604 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5605 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5606 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5607 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005608 scripts/config.py unset MBEDTLS_ECDH_C
5609
Przemek Stekiela01c2422023-06-13 10:46:48 +02005610 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5611
5612 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5613 cd tests; ./test_suite_ssl; cd ..
5614
5615 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5616 tests/ssl-opt.sh
5617}
5618
Ronald Cronc3f43b62022-10-17 17:35:32 +02005619component_test_tls13_only_psk_ephemeral () {
5620 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5621 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5622 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5623 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5624 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5625 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5626 scripts/config.py unset MBEDTLS_ECDSA_C
5627 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005628 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005629 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005630 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5631
5632 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5633 cd tests; ./test_suite_ssl; cd ..
5634
5635 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5636 tests/ssl-opt.sh
5637}
5638
Przemek Stekiela01c2422023-06-13 10:46:48 +02005639component_test_tls13_only_psk_ephemeral_ffdh () {
5640 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5641 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5642 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5643 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5644 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5645 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5646 scripts/config.py unset MBEDTLS_ECDSA_C
5647 scripts/config.py unset MBEDTLS_PKCS1_V21
5648 scripts/config.py unset MBEDTLS_PKCS7_C
5649 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005650 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005651 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5652
5653 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5654 cd tests; ./test_suite_ssl; cd ..
5655
5656 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5657 tests/ssl-opt.sh
5658}
5659
Ronald Cronc3f43b62022-10-17 17:35:32 +02005660component_test_tls13_only_psk_all () {
5661 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5662 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5663 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5664 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5665 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5666 scripts/config.py unset MBEDTLS_ECDSA_C
5667 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005668 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005669 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005670 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5671
5672 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5673 cd tests; ./test_suite_ssl; cd ..
5674
5675 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5676 tests/ssl-opt.sh
5677}
5678
5679component_test_tls13_only_ephemeral_all () {
5680 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5681 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005682 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005683 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5684
5685 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5686 cd tests; ./test_suite_ssl; cd ..
5687
5688 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5689 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005690}
5691
Ronald Cron6f135e12021-12-08 16:57:54 +01005692component_test_tls13 () {
5693 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5694 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005695 scripts/config.py set MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5696 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005697 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005698 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005699 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005700 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005701 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005702 msg "ssl-opt.sh (TLS 1.3)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005703 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005704}
5705
Ronald Cron6f135e12021-12-08 16:57:54 +01005706component_test_tls13_no_compatibility_mode () {
5707 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5708 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005709 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5710 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005711 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005712 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005713 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005714 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005715 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005716 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005717 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005718}
5719
Jan Bruckner151f6422023-02-10 12:45:19 +01005720component_test_tls13_only_record_size_limit () {
5721 msg "build: TLS 1.3 only from default, record size limit extension enabled"
5722 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
5723 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5724
5725 msg "test_suite_ssl: TLS 1.3 only, record size limit extension enabled"
5726 cd tests; ./test_suite_ssl; cd ..
5727
5728 msg "ssl-opt.sh: (TLS 1.3 only, record size limit extension tests only)"
5729 # Both the server and the client will currently abort the handshake when they encounter the
5730 # record size limit extension. There is no way to prevent gnutls-cli from sending the extension
5731 # which makes all G_NEXT_CLI + P_SRV tests fail. Thus, run only the tests for the this extension.
5732 tests/ssl-opt.sh -f "Record Size Limit"
5733}
5734
Gilles Peskine8f073122018-11-27 15:58:47 +01005735component_build_mingw () {
5736 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005737 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 +00005738
Gilles Peskine8f073122018-11-27 15:58:47 +01005739 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005740 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 +01005741 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005742
Gilles Peskine8f073122018-11-27 15:58:47 +01005743 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005744 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
5745 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 +01005746 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005747
Pengyu Lv158eead2023-10-19 11:27:05 +08005748 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005749 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005750 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 +01005751 make WINDOWS_BUILD=1 clean
5752}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005753support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005754 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5755 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005756 *) true;;
5757 esac
5758}
Simon Butcher91aef332016-11-17 09:20:50 +00005759
Gilles Peskine8f073122018-11-27 15:58:47 +01005760component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005761 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005762 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005763 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5764 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005765
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005766 msg "test: main suites (MSan)" # ~ 10s
5767 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005768
Gilles Peskine6848d172023-11-02 19:58:03 +01005769 msg "test: metatests (MSan)"
5770 tests/scripts/run-metatests.sh any msan
5771
Gilles Peskine82b27272019-06-14 18:27:03 +02005772 msg "program demos (MSan)" # ~20s
5773 tests/scripts/run_demos.py
5774
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005775 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005776 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005777
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005778 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005779
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005780 if [ "$MEMORY" -gt 0 ]; then
5781 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005782 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005783 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005784}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005785
Bence Szépkúti0354d042023-12-06 16:14:37 +01005786component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005787 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005788 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005789 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5790 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005791
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005792 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005793 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005794
Gilles Peskine636c26a2020-03-04 20:46:15 +01005795 # Optional parts (slow; currently broken on OS X because programs don't
5796 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005797 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005798 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005799 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005800 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005801 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005802
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005803 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005804 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005805 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005806 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005807
5808 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005809 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005810 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005811 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005812}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005813
Bence Szépkúti0354d042023-12-06 16:14:37 +01005814component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005815 msg "build: Release, full (clang)"
5816 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5817 scripts/config.py full
5818 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5819 make
5820
5821 msg "test: main suites, Valgrind (full config)"
5822 make memcheck
5823}
5824
Paul Elliott62dc3922021-11-25 17:29:40 +00005825support_test_cmake_out_of_source () {
5826 distrib_id=""
5827 distrib_ver=""
5828 distrib_ver_minor=""
5829 distrib_ver_major=""
5830
5831 # Attempt to parse lsb-release to find out distribution and version. If not
5832 # found this should fail safe (test is supported).
5833 if [[ -f /etc/lsb-release ]]; then
5834
5835 while read -r lsb_line; do
5836 case "$lsb_line" in
5837 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5838 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5839 esac
5840 done < /etc/lsb-release
5841
5842 distrib_ver_major="${distrib_ver%%.*}"
5843 distrib_ver="${distrib_ver#*.}"
5844 distrib_ver_minor="${distrib_ver%%.*}"
5845 fi
5846
5847 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5848 # processor (as the CI does) can create a race condition whereby the build
5849 # fails to see a generated file, despite that file actually having been
5850 # generated. This problem appears to go away with 18.04 or newer, so make
5851 # the out of source tests unsupported on Ubuntu 16.04.
5852 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5853}
5854
Gilles Peskine8f073122018-11-27 15:58:47 +01005855component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005856 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005857 # generates
5858 make neat
5859
Gilles Peskine8f073122018-11-27 15:58:47 +01005860 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005861 MBEDTLS_ROOT_DIR="$PWD"
5862 mkdir "$OUT_OF_SOURCE_DIR"
5863 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005864 # Note: Explicitly generate files as these are turned off in releases
5865 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005866 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005867
Gilles Peskine8f073122018-11-27 15:58:47 +01005868 msg "test: cmake 'out-of-source' build"
5869 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005870 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005871 # Also ensure that there are no error messages such as
5872 # "No such file or directory", which would indicate that some required
5873 # file is missing (ssl-opt.sh tolerates the absence of some files so
5874 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005875 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005876 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005877 cat ssl-opt.err >&2
5878 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005879 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005880 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005881 cd "$MBEDTLS_ROOT_DIR"
5882 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005883}
Andres AGdc192212016-08-31 17:33:13 +01005884
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005885component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005886 # Remove existing generated files so that we use the ones CMake
5887 # generates
5888 make neat
5889
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005890 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005891 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005892 # Note: Explicitly generate files as these are turned off in releases
5893 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005894 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005895 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005896}
Gilles Peskinea3000992022-02-04 00:21:12 +01005897support_test_cmake_as_subdirectory () {
5898 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005899}
5900
Chris Kayd259e342021-03-25 16:03:25 +00005901component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005902 # Remove existing generated files so that we use the ones CMake
5903 # generates
5904 make neat
5905
Chris Kayd259e342021-03-25 16:03:25 +00005906 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005907 cd programs/test/cmake_package
5908 cmake .
5909 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005910 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005911}
Gilles Peskinea3000992022-02-04 00:21:12 +01005912support_test_cmake_as_package () {
5913 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005914}
5915
5916component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005917 # Remove existing generated files so that we use the ones CMake
5918 # generates
5919 make neat
5920
Chris Kayd259e342021-03-25 16:03:25 +00005921 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005922 cd programs/test/cmake_package_install
5923 cmake .
5924 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005925 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005926}
Gilles Peskinea3000992022-02-04 00:21:12 +01005927support_test_cmake_as_package_install () {
5928 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005929}
5930
David Horstmann20550e32023-01-12 14:17:01 +00005931component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005932 # Make a copy of config file to use for the in-tree test
5933 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005934
5935 MBEDTLS_ROOT_DIR="$PWD"
5936 mkdir "$OUT_OF_SOURCE_DIR"
5937 cd "$OUT_OF_SOURCE_DIR"
5938
David Horstmann969c1452023-01-31 10:34:44 +00005939 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005940 cmake "$MBEDTLS_ROOT_DIR"
5941 make
5942
5943 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5944 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005945 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005946 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5947 make
5948
5949 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5950 # In the user config, disable one feature (for simplicity, pick a feature
5951 # that nothing else depends on).
5952 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5953
5954 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5955 make
5956 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5957
5958 rm -f user_config.h full_config.h
5959
5960 cd "$MBEDTLS_ROOT_DIR"
5961 rm -rf "$OUT_OF_SOURCE_DIR"
5962
5963 # Now repeat the test for an in-tree build:
5964
David Horstmann969c1452023-01-31 10:34:44 +00005965 # Restore config for the in-tree test
5966 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005967
David Horstmann969c1452023-01-31 10:34:44 +00005968 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005969 cmake .
5970 make
5971
5972 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5973 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005974 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005975 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5976 make
5977
5978 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5979 # In the user config, disable one feature (for simplicity, pick a feature
5980 # that nothing else depends on).
5981 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5982
5983 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5984 make
5985 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5986
5987 rm -f user_config.h full_config.h
5988}
5989support_build_cmake_custom_config_file () {
5990 support_test_cmake_out_of_source
5991}
5992
5993
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005994component_build_zeroize_checks () {
5995 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5996
5997 scripts/config.py full
5998
5999 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Tom Cosgroveb2fafa52023-09-01 14:40:21 +01006000 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 +01006001}
6002
6003
Gilles Peskine8f073122018-11-27 15:58:47 +01006004component_test_zeroize () {
6005 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6006 # different combinations of compilers and optimization flags by using an
6007 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6008 # system in all cases that the script fails, so we must manually search the
6009 # output to check whether the pass string is present and no failure strings
6010 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006011
Gilles Peskine4976e822019-01-06 19:52:22 +00006012 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6013 # about a spurious message if Gdb tries and fails, so suppress that.
6014 gdb_disable_aslr=
6015 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6016 gdb_disable_aslr='set disable-randomization off'
6017 fi
6018
Gilles Peskine8f073122018-11-27 15:58:47 +01006019 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006020 for compiler in clang gcc; do
6021 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6022 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006023 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6024 grep "The buffer was correctly zeroized" test_zeroize.log
6025 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006026 rm -f test_zeroize.log
6027 make clean
6028 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006029 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006030}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006031
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006032component_test_psa_compliance () {
6033 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Bence Szépkútica9236b2021-10-25 19:29:07 +02006034 make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006035
6036 msg "unit test: test_psa_compliance.py"
6037 ./tests/scripts/test_psa_compliance.py
6038}
6039
6040support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006041 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006042 ver="$(cmake --version)"
6043 ver="${ver#cmake version }"
6044 ver_major="${ver%%.*}"
6045
6046 ver="${ver#*.}"
6047 ver_minor="${ver%%.*}"
6048
6049 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006050}
6051
Gilles Peskinec848d222022-12-09 12:23:35 +01006052component_check_code_style () {
6053 msg "Check C code style"
6054 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006055}
6056
Gilles Peskinec848d222022-12-09 12:23:35 +01006057support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006058 case $(uncrustify --version) in
6059 *0.75.1*) true;;
6060 *) false;;
6061 esac
6062}
6063
Gilles Peskine8f073122018-11-27 15:58:47 +01006064component_check_python_files () {
6065 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006066 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006067}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006068
Joe Subbianid614c0b2021-07-29 11:18:29 +01006069component_check_test_helpers () {
6070 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006071 # unittest writes out mundane stuff like number or tests run on stderr.
6072 # Our convention is to reserve stderr for actual errors, and write
6073 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006074 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006075
Joe Subbiania25ffab2021-08-06 09:41:27 +01006076 msg "unit test: translate_ciphers.py"
6077 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006078}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006079
Jerry Yud767cc42023-03-31 15:03:55 +08006080
Gilles Peskine192c72f2017-12-21 15:59:21 +01006081################################################################
6082#### Termination
6083################################################################
6084
Gilles Peskine8f073122018-11-27 15:58:47 +01006085post_report () {
6086 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006087 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006088
Gilles Peskine8f073122018-11-27 15:58:47 +01006089 final_report
6090}
6091
6092
6093
6094################################################################
6095#### Run all the things
6096################################################################
6097
Gilles Peskine5d996822020-03-28 21:09:21 +01006098# Function invoked by --error-test to test error reporting.
6099pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006100 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006101 if [ $KEEP_GOING -ne 0 ]; then
6102 echo "Expect three failing commands."
6103 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006104 # If the component doesn't run in a subshell, changing error_test_i to an
6105 # invalid integer will cause an error in the loop that runs this function.
6106 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006107 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006108 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006109 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006110 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006111 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006112 make unknown_target
6113 false "this should not be executed"
6114}
6115
Gilles Peskinee48351a2018-11-27 16:06:30 +01006116# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006117run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006118 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006119 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006120
6121 # Unconditionally create a seedfile that's sufficiently long.
6122 # Do this before each component, because a previous component may
6123 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006124 local dd_cmd
6125 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6126 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006127 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006128 esac
6129 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006130
Gilles Peskineec135542021-08-02 23:14:03 +02006131 # Run the component in a subshell, with error trapping and output
6132 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006133 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006134 # We want to keep running if the subshell fails, so 'set -e' must
6135 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006136 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006137 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006138 (
6139 if [ $QUIET -eq 1 ]; then
6140 # msg() will be silenced, so just print the component name here.
6141 echo "${current_component#component_}"
6142 exec >/dev/null
6143 fi
6144 if [ $KEEP_GOING -eq 1 ]; then
6145 # Keep "set -e" off, and run an ERR trap instead to record failures.
6146 set -E
6147 trap err_trap ERR
6148 fi
6149 # The next line is what runs the component
6150 "$@"
6151 if [ $KEEP_GOING -eq 1 ]; then
6152 trap - ERR
6153 exit $last_failure_status
6154 fi
6155 )
6156 component_status=$?
6157 if [ $KEEP_GOING -eq 1 ]; then
6158 set -e
6159 if [ $component_status -ne 0 ]; then
6160 failure_count=$((failure_count + 1))
6161 fi
6162 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006163
6164 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006165 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006166 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006167}
6168
6169# Preliminary setup
6170pre_check_environment
Tom Cosgrove730addc2023-06-09 14:20:18 +01006171pre_parse_command_line_for_dirs "$@"
Gilles Peskine8f073122018-11-27 15:58:47 +01006172pre_initialize_variables
6173pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006174
Gilles Peskine878cf602019-01-06 20:50:38 +00006175pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006176pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006177pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006178
Gilles Peskine878cf602019-01-06 20:50:38 +00006179build_status=0
6180if [ $KEEP_GOING -eq 1 ]; then
6181 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006182fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006183pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006184pre_print_configuration
6185pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006186cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006187if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006188 pre_generate_files
6189fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006190
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006191# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006192for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006193 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006194done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006195unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006196for component in $RUN_COMPONENTS; do
6197 run_component "component_$component"
6198done
Gilles Peskine8f073122018-11-27 15:58:47 +01006199
6200# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006201post_report