blob: 3f7ad957d4f31945731650cc11ee07392199d186 [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.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100136 else
137 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100138 fi
John Durkopbd069d32020-10-31 22:14:03 -0700139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100140 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200141
142 # Files that are clobbered by some jobs will be backed up. Use a different
143 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
144 # independently decide when to remove the backup file.
145 backup_suffix='.all.bak'
146 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100147 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100148 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 # Files clobbered by in-tree cmake
150 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
151 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200152
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200153 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100154 MEMORY=0
155 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200156 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100158
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200159 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200160 #
161 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
162 # both values are kept in sync. If you change the value here because it
163 # breaks some tests, you'll definitely want to change it in
164 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200165 RELEASE_SEED=1
166
Yanray Wang18040ed2023-11-23 21:29:56 +0800167 # Specify character collation for regular expressions and sorting with C locale
168 export LC_COLLATE=C
169
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200170 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200171 : ${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 +0200172 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200173 export MBEDTLS_TEST_PLATFORM
174
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000175 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL_NEXT:="$OPENSSL"}
178 : ${GNUTLS_CLI:="gnutls-cli"}
179 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100180 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
181 : ${ARMC5_BIN_DIR:=/usr/bin}
182 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200183 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200184 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100185 : ${CLANG_LATEST:="clang-latest"}
186 : ${CLANG_EARLIEST:="clang-earliest"}
187 : ${GCC_LATEST:="gcc-latest"}
188 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000190 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200191 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100192 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000193 # if CC is not set, use clang by default (if present) to improve build times
194 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000195 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000196 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000197
Gilles Peskine396853a2021-09-20 18:57:55 +0200198 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000199 export CTEST_OUTPUT_ON_FAILURE=1
200
Gilles Peskine8fd59422019-10-21 17:11:33 +0200201 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100202 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200203 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000204 # Normally, tests should use this compiler for ASAN testing
205 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200206
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400207 # Platform tests have an allocation that returns null
208 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400209 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400210
Gilles Peskine878cf602019-01-06 20:50:38 +0000211 # Gather the list of available components. These are the functions
212 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100213 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000214
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000215 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100216 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100217}
Andres AG38495a32016-07-12 16:54:33 +0100218
Dave Rodgman21900632024-02-26 11:41:19 +0000219setup_quiet_wrappers()
220{
221 # Pick up "quiet" wrappers for make and cmake, which don't output very much
222 # unless there is an error. This reduces logging overhead in the CI.
223 #
224 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000225 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
226 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000227 fi
228}
229
Gilles Peskinea28db922019-01-10 00:05:18 +0100230# Test whether the component $1 is included in the command line patterns.
231is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100232{
Gilles Peskine03af6782021-08-06 11:35:17 +0200233 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
234 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100235 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000236 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100237 set +f
238 case ${1#component_} in $pattern) return 0;; esac
239 done
240 set +f
241 return 1
242}
Andres AG7770ea82016-10-10 15:46:20 +0100243
Simon Butcher41eeccf2016-09-07 00:07:09 +0100244usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100245{
Gilles Peskine709346a2017-12-10 23:43:39 +0100246 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100247Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100248Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100249By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100250COMPONENT can be the name of a component or a shell wildcard pattern.
251
252Examples:
253 $0 "check_*"
254 Run all sanity checks.
255 $0 --no-armcc --except test_memsan
256 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100257
258Special options:
259 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000260 --list-all-components List all available test components and exit.
261 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100262
263General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200264 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100265 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100266 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100267 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200268 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200269 --arm-none-eabi-gcc-prefix=<string>
270 Prefix for a cross-compiler for arm-none-eabi
271 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200272 --arm-linux-gnueabi-gcc-prefix=<string>
273 Prefix for a cross-compiler for arm-linux-gnueabi
274 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100275 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200276 --restore First clean up the build tree, restoring backed up
277 files. Do not run any components unless they are
278 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100279 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200280 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100281 --except Exclude the COMPONENTs listed on the command line,
282 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200283 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100284 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100285 --no-force Refuse to overwrite modified files (default).
286 --no-keep-going Stop at the first error (default).
287 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800288 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100289 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200290 --outcome-file=<path> File where test outcomes are written (not done if
291 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100292 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200293 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100294 -s|--seed Integer seed value to use for this test run.
295
296Tool path options:
297 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
298 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100299 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
300 --clang-latest=<Clang_latest_path> Latest version of clang available
301 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
302 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100303 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
304 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100305 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100306 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100307EOF
SimonB2e23c822016-04-16 21:54:39 +0100308}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100309
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200310# Cleanup before/after running a component.
311# Remove built files as well as the cmake cache/config.
312# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313cleanup()
314{
David Horstmann76a77382023-08-17 17:32:26 +0100315 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100316 command make clean
317 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200318
Gilles Peskine31b07e22018-03-21 12:15:06 +0100319 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000320 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100321 -iname CMakeFiles -exec rm -rf {} \+ -o \
322 \( -iname cmake_install.cmake -o \
323 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200324 -iname CMakeCache.txt -o \
325 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100326 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200327 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200328
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100329 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
330 rm -rf programs/test/cmake_subproject/build
331 rm -f programs/test/cmake_subproject/Makefile
332 rm -f programs/test/cmake_subproject/cmake_subproject
333
Chris Kayd259e342021-03-25 16:03:25 +0000334 # Remove any artifacts from the component_test_cmake_as_package test.
335 rm -rf programs/test/cmake_package/build
336 rm -f programs/test/cmake_package/Makefile
337 rm -f programs/test/cmake_package/cmake_package
338
339 # Remove any artifacts from the component_test_cmake_as_installed_package test.
340 rm -rf programs/test/cmake_package_install/build
341 rm -f programs/test/cmake_package_install/Makefile
342 rm -f programs/test/cmake_package_install/cmake_package_install
343
Gilles Peskinef83eb822020-03-30 20:11:39 +0200344 # Restore files that may have been clobbered by the job
345 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200346 if [[ -e "$x$backup_suffix" ]]; then
347 cp -p "$x$backup_suffix" "$x"
348 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200349 done
350}
John Durkopbd069d32020-10-31 22:14:03 -0700351
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200352# Final cleanup when this script exits (except when exiting on a failure
353# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200354final_cleanup () {
355 cleanup
356
357 for x in $files_to_back_up; do
358 rm -f "$x$backup_suffix"
359 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100360}
361
Gilles Peskine7c652162017-12-11 00:01:40 +0100362# Executed on exit. May be redefined depending on command line options.
363final_report () {
364 :
365}
366
367fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200368 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100369 final_report $1
370 trap - $1
371 kill -$1 $$
372}
373
374trap 'fatal_signal HUP' HUP
375trap 'fatal_signal INT' INT
376trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200377
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200378# Number of processors on this machine. Used as the default setting
379# for parallel make.
380all_sh_nproc ()
381{
382 {
383 nproc || # Linux
384 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
385 sysctl -n hw.ncpu || # FreeBSD
386 echo 1
387 } 2>/dev/null
388}
389
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100390msg()
391{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100392 if [ -n "${current_component:-}" ]; then
393 current_section="${current_component#component_}: $1"
394 else
395 current_section="$1"
396 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200397
398 if [ $QUIET -eq 1 ]; then
399 return
400 fi
401
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100402 echo ""
403 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100404 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000405 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo "******************************************************************"
407}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100408
Gilles Peskine8f073122018-11-27 15:58:47 +0100409armc6_build_test()
410{
411 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100412
Gilles Peskine18487f62020-04-30 23:11:54 +0200413 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800414 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100415 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000416 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200417
418 msg "size: ARM Compiler 6 ($FLAGS)"
419 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100420}
Andres AGa5cd9732016-10-17 15:23:10 +0100421
Andres AGd9eba4b2016-08-26 14:42:14 +0100422err_msg()
423{
424 echo "$1" >&2
425}
426
427check_tools()
428{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200429 for tool in "$@"; do
430 if ! `type "$tool" >/dev/null 2>&1`; then
431 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100432 exit 1
433 fi
434 done
435}
436
Gilles Peskine8f073122018-11-27 15:58:47 +0100437pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000438 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100439 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100440 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100441 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200442 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000443 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100444
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000445 # Note that legacy options are ignored instead of being omitted from this
446 # list of options, so invocations that worked with previous version of
447 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100448 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100449 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200450 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200451 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200452 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000453 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100454 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
455 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100456 --clang-earliest) shift; CLANG_EARLIEST="$1";;
457 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100458 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000459 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100460 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100461 --gcc-earliest) shift; GCC_EARLIEST="$1";;
462 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100463 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200464 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
465 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100466 --gnutls-serv) shift; GNUTLS_SERV="$1";;
467 --help|-h) usage; exit;;
468 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000469 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100470 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100471 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200472 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000473 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100474 --no-force) FORCE=0;;
475 --no-keep-going) KEEP_GOING=0;;
476 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200477 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100479 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200480 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200482 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200484 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200485 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --seed|-s) shift; SEED="$1";;
487 -*)
488 echo >&2 "Unknown option: $1"
489 echo >&2 "Run $0 --help for usage."
490 exit 120
491 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000492 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 esac
494 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100495 done
SimonB2e23c822016-04-16 21:54:39 +0100496
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100497 # Exclude components that are not supported on this platform.
498 SUPPORTED_COMPONENTS=
499 for component in $ALL_COMPONENTS; do
500 case $(type "support_$component" 2>&1) in
501 *' function'*)
502 if ! support_$component; then continue; fi;;
503 esac
504 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
505 done
506
507 if [ $list_components -eq 1 ]; then
508 printf '%s\n' $SUPPORTED_COMPONENTS
509 exit
510 fi
511
Gilles Peskinea28db922019-01-10 00:05:18 +0100512 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200513 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000514 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100515 fi
516
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000517 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
518 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100519 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000520 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100521 fi
SimonB2e23c822016-04-16 21:54:39 +0100522
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200523 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100524 if [ $all_except -eq 0 ]; then
525 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200526 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
527 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200528 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100529 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200530 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200531 # If the requested name includes a wildcard character, don't
532 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 case $component in
534 *[*?\[]*) continue;;
535 esac
536 case " $SUPPORTED_COMPONENTS " in
537 *" $component "*) :;;
538 *)
539 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
540 unsupported=$((unsupported + 1));;
541 esac
542 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200543 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100544 if [ $unsupported -ne 0 ]; then
545 exit 2
546 fi
547 fi
548
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000549 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100550 RUN_COMPONENTS=
551 for component in $SUPPORTED_COMPONENTS; do
552 if is_component_included "$component"; [ $? -eq $all_except ]; then
553 RUN_COMPONENTS="$RUN_COMPONENTS $component"
554 fi
555 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000556
557 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000558 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100559}
SimonB2e23c822016-04-16 21:54:39 +0100560
Gilles Peskine8f073122018-11-27 15:58:47 +0100561pre_check_git () {
562 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100563 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100564 git checkout-index -f -q $CONFIG_H
565 cleanup
566 else
SimonB2e23c822016-04-16 21:54:39 +0100567
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
569 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
570 echo "You can either delete this directory manually, or force the test by rerunning"
571 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
572 exit 1
573 fi
574
Ronald Cron7a93ac52023-07-20 09:49:12 +0200575 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100576 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100577 echo "You can either delete or preserve your work, or force the test by rerunning the"
578 echo "script as: $0 --force"
579 exit 1
580 fi
SimonB2e23c822016-04-16 21:54:39 +0100581 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500582}
583
Gilles Peskine568f53a2021-07-12 18:16:01 +0200584pre_restore_files () {
585 # If the makefiles have been generated by a framework such as cmake,
586 # restore them from git. If the makefiles look like modifications from
587 # the ones checked into git, take care not to modify them. Whatever
588 # this function leaves behind is what the script will restore before
589 # each component.
590 case "$(head -n1 Makefile)" in
591 *[Gg]enerated*)
592 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
593 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
594 ;;
595 esac
596}
597
Gilles Peskinef83eb822020-03-30 20:11:39 +0200598pre_back_up () {
599 for x in $files_to_back_up; do
600 cp -p "$x" "$x$backup_suffix"
601 done
602}
603
Gilles Peskine8f073122018-11-27 15:58:47 +0100604pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100605 failure_count=0 # Number of failed components
606 last_failure_status=0 # Last failure status in this component
607
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100608 # See err_trap
609 previous_failure_status=0
610 previous_failed_command=
611 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100612 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100613
Gilles Peskine7c652162017-12-11 00:01:40 +0100614 start_red=
615 end_color=
616 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100617 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
619 start_red=$(printf '\033[31m')
620 end_color=$(printf '\033[0m')
621 ;;
622 esac
623 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100624
625 # Keep a summary of failures in a file. We'll print it out at the end.
626 failure_summary_file=$PWD/all-sh-failures-$$.log
627 : >"$failure_summary_file"
628
629 # Whether it makes sense to keep a component going after the specified
630 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200631 # This function normally receives the failing simple command
632 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
633 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100634 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200635 # False positives result in running things that can't be expected to
636 # work. False negatives result in things not running after something else
637 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 can_keep_going_after_failure () {
639 case "$1" in
640 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200641 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100642 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200643 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
644 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
645 *make*check*) true;;
646 "grep "*) true;;
647 "[ "*) true;;
648 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100649 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100650 esac
651 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100652
653 # This function runs if there is any error in a component.
654 # It must either exit with a nonzero status, or set
655 # last_failure_status to a nonzero value.
656 err_trap () {
657 # Save $? (status of the failing command). This must be the very
658 # first thing, before $? is overridden.
659 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100660 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100661
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100662 if [[ $last_failure_status -eq $previous_failure_status &&
663 "$failed_command" == "$previous_failed_command" &&
664 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
665 then
666 # The same command failed twice in a row, but this time one level
667 # less deep in the function call stack. This happens when the last
668 # command of a function returns a nonzero status, and the function
669 # returns that same status. Ignore the second failure.
670 previous_failure_funcall_depth=${#FUNCNAME[@]}
671 return
672 fi
673 previous_failure_status=$last_failure_status
674 previous_failed_command=$failed_command
675 previous_failure_funcall_depth=${#FUNCNAME[@]}
676
Gilles Peskinece266c42020-03-28 18:50:43 +0100677 text="$current_section: $failed_command -> $last_failure_status"
678 echo "${start_red}^^^^$text^^^^${end_color}" >&2
679 echo "$text" >>"$failure_summary_file"
680
681 # If the command is fatal (configure or build command), stop this
682 # component. Otherwise (test command) keep the component running
683 # (run more tests from the same build).
684 if ! can_keep_going_after_failure "$failed_command"; then
685 exit $last_failure_status
686 fi
687 }
688
Gilles Peskine7c652162017-12-11 00:01:40 +0100689 final_report () {
690 if [ $failure_count -gt 0 ]; then
691 echo
692 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100693 echo "${start_red}FAILED: $failure_count components${end_color}"
694 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100695 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
696 elif [ -z "${1-}" ]; then
697 echo "SUCCESS :)"
698 fi
699 if [ -n "${1-}" ]; then
700 echo "Killed by SIG$1."
701 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100702 rm -f "$failure_summary_file"
703 if [ $failure_count -gt 0 ]; then
704 exit 1
705 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100706 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100707}
708
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200709# record_status() and if_build_succeeded() are kept temporarily for backward
710# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100711record_status () {
712 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100713}
Gilles Peskine7c652162017-12-11 00:01:40 +0100714if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100715 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100716}
717
Gilles Peskinea681c592020-03-28 21:27:40 +0100718# '! true' does not trigger the ERR trap. Arrange to trigger it, with
719# a reasonably informative error message (not just "$@").
720not () {
721 if "$@"; then
722 report_failed_command="! $*"
723 false
724 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200725 fi
726}
727
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200728pre_prepare_outcome_file () {
729 case "$MBEDTLS_TEST_OUTCOME_FILE" in
730 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
731 esac
732 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
733 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
734 fi
735}
736
Gilles Peskine8f073122018-11-27 15:58:47 +0100737pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200738 if [ $QUIET -eq 1 ]; then
739 return
740 fi
741
Gilles Peskine8f073122018-11-27 15:58:47 +0100742 msg "info: $0 configuration"
743 echo "MEMORY: $MEMORY"
744 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200745 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100747 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100748 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100749 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
750 echo "GNUTLS_CLI: $GNUTLS_CLI"
751 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
753 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
754}
Andres AG7770ea82016-10-10 15:46:20 +0100755
Andres AGd9eba4b2016-08-26 14:42:14 +0100756# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100757pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000758 # Build the list of variables to pass to output_env.sh.
759 set env
SimonB2e23c822016-04-16 21:54:39 +0100760
Gilles Peskine87964262019-01-06 22:40:00 +0000761 case " $RUN_COMPONENTS " in
762 # Require OpenSSL and GnuTLS if running any tests (as opposed to
763 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
764 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100765 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000766 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
767 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100768 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000769 export GNUTLS_CLI="$GNUTLS_CLI"
770 export GNUTLS_SERV="$GNUTLS_SERV"
771 # Avoid passing --seed flag in every call to ssl-opt.sh
772 if [ -n "${SEED-}" ]; then
773 export SEED
774 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200775 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000776 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200777 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
778 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000779 ;;
780 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200781
Gilles Peskine87964262019-01-06 22:40:00 +0000782 case " $RUN_COMPONENTS " in
783 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
784 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200787 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
791 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
792 esac
793
794 case " $RUN_COMPONENTS " in
795 *" test_zeroize "*) check_tools "gdb";;
796 esac
797
798 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000799 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000800 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
801 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200802 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000803 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
804 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200805 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
806 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
807 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000808 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000809
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200810 # past this point, no call to check_tool, only printing output
811 if [ $QUIET -eq 1 ]; then
812 return
813 fi
814
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000815 msg "info: output_env.sh"
816 case $RUN_COMPONENTS in
817 *_armcc*)
818 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
819 *) set "$@" RUN_ARMCC=0;;
820 esac
821 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100822}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100823
Gilles Peskine1570b592021-04-22 01:10:12 +0200824pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200825 # since make doesn't have proper dependencies, remove any possibly outdate
826 # file that might be around before generating fresh ones
827 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200828 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200829 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200830 else
831 make generated_files
832 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200833}
834
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000835clang_version() {
836 if command -v clang > /dev/null ; then
837 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
838 else
839 echo 0 # report version 0 for "no clang"
840 fi
841}
842
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200843################################################################
844#### Helpers for components using libtestdriver1
845################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100846
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200847# How to use libtestdriver1
848# -------------------------
849#
850# 1. Define the list algorithms and key types to accelerate,
851# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
852# Examples:
853# - loc_accel_list="ALG_JPAKE"
854# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200855# 2. Make configurations changes for the driver and/or main libraries.
856# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
857# can be either "default" to start with the default config, or a name
858# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200859# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200860# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
861# These changes affect both the driver and the main libraries.
862# (Note: they need to have the same set of PSA_WANT symbols, as that
863# determines the ABI between them.)
864# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
865# main libraries. Typically, you want to disable the module(s) that are
866# being accelerated. You may need to also disable modules that depend
867# on them or options that are not supported with drivers.
868# 2d. On top of psa/crypto_config.h, the driver library uses its own config
869# file: tests/include/test/drivers/config_test_driver.h. You usually
870# don't need to edit it: using loc_extra_list (see below) is preferred.
871# However, when there's no PSA symbol for what you want to enable,
872# calling scripts/config.py on this file remains the only option.
873# 3. Build the driver library, then the main libraries, test, and programs.
874# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
875# need to enable more algorithms here, typically hash algorithms when
876# accelerating some signature algorithms (ECDSA, RSAv2). This is done
877# by passing a 2nd argument listing the extra algorithms.
878# Example:
879# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
880# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800881# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200882# additional arguments will be passed to make: this can be useful if
883# you don't want to build everything when iterating during development.
884# Example:
885# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
886# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200887
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200888# Adjust the configuration - for both libtestdriver1 and main library,
889# as they should have the same PSA_WANT macros.
890helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200891 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200892 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200893 if [ "$base_config" != "default" ]; then
894 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200895 fi
896
897 # Enable PSA-based config (necessary to use drivers)
898 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
899
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200900 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
901 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
902 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000903
904 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
905 # otherwise we will end up running multithreaded tests without mutexes to protect them.
906 if scripts/config.py get MBEDTLS_THREADING_C; then
907 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
908 fi
909
910 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
912 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200913}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100914
Valerio Settib2fd6732023-08-15 17:10:47 +0200915# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200916# The function optionally accepts 1 parameter: a space-separated list of the
917# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200918helper_disable_builtin_curves() {
919 allowed_list="${1:-}"
920 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
921
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200922 for curve in $allowed_list; do
923 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200924 done
925}
926
927# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
928# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
929# in the following helpers.
930helper_get_psa_curve_list () {
931 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200932 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
933 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200934 done
935
936 echo "$loc_list"
937}
938
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100939# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
940# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
941# in the following helpers.
942helper_get_psa_dh_group_list () {
943 loc_list=""
944 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
945 loc_list="$loc_list $item"
946 done
947
948 echo "$loc_list"
949}
950
Valerio Settib2fd6732023-08-15 17:10:47 +0200951# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200952# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200953# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200954helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200955 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200956 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200957 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 +0200958 # Skip DERIVE for elliptic keys since there is no driver dispatch for
959 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200960 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
961 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200962 fi
963 done
964
965 echo "$loc_list"
966}
967
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200968# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200969#
970# Parameters:
971# 1. a space-separated list of things to accelerate;
972# 2. optional: a space-separate list of things to also support.
973# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
974helper_libtestdriver1_make_drivers() {
975 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100976 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 +0200977}
978
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200979# Build the main libraries, programs and tests,
980# linking to the drivers library (with ASan).
981#
982# Parameters:
983# 1. a space-separated list of things to accelerate;
984# *. remaining arguments if any are passed directly to make
985# (examples: lib, -C tests test_suite_xxx, etc.)
986# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
987helper_libtestdriver1_make_main() {
988 loc_accel_list=$1
989 shift
990
991 # we need flags both with and without the LIBTESTDRIVER1_ prefix
992 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
993 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100994 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 +0200995}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100996
997################################################################
998#### Basic checks
999################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001000
1001#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001002# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001003#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001004# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001005# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001006# 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 +02001007# time, so start with a GCC build).
1008# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001009#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001010# Indicative running times are given for reference.
1011
Gilles Peskine8f073122018-11-27 15:58:47 +01001012component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001013 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001014 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001015}
Janos Follathb72c6782016-07-19 14:54:17 +01001016
Gilles Peskine67debb62021-05-18 16:09:50 +02001017component_check_generated_files () {
1018 msg "Check: check-generated-files, files generated with make" # 2s
1019 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001020 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001021
1022 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001023 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001024 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001025 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001026
1027 msg "Check: check-generated-files -u, files absent" # 2s
1028 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001029 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001030 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001031 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001032
1033 # This component ends with the generated files present in the source tree.
1034 # This is necessary for subsequent components!
1035}
1036
Gilles Peskine8f073122018-11-27 15:58:47 +01001037component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001038 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001039 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001040}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001041
Gilles Peskine8f073122018-11-27 15:58:47 +01001042component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001043 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001044 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001045}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001047component_check_changelog () {
1048 msg "Check: changelog entries" # < 1s
1049 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001050 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001051 if [ -e ChangeLog.new ]; then
1052 # Show the diff for information. It isn't an error if the diff is
1053 # non-empty.
1054 diff -u ChangeLog ChangeLog.new || true
1055 rm ChangeLog.new
1056 fi
1057}
1058
Gilles Peskine8f073122018-11-27 15:58:47 +01001059component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001060 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001061 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001062}
Darryl Greena07039c2018-03-13 16:48:16 +00001063
Gilles Peskine895868b2019-09-19 21:30:05 +02001064component_check_test_cases () {
1065 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001066 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001067 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001068 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001069 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001070 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001071 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001072 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001073}
1074
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001075component_check_test_dependencies () {
1076 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001077 # The purpose of this component is to catch unjustified dependencies on
1078 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1079 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1080 # MBEDTLS_PSA_xxx).
1081 #
1082 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1083 # this component is meant to catch. However a few of them are justified,
1084 # mostly by the absence of a PSA equivalent, so this component includes a
1085 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001086
1087 found="check-test-deps-found-$$"
1088 expected="check-test-deps-expected-$$"
1089
1090 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001091 grep 'depends_on' \
1092 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001093 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001094 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001095 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001096
Yanray Wang18040ed2023-11-23 21:29:56 +08001097 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001098 rm -f $expected
1099 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1100 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001101 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1102 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001103 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1104 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001105 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1106 # the test code and that's probably the most convenient way of achieving
1107 # the test's goal.
1108 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1109 # No PSA equivalent - we should probably have one in the future.
1110 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1111 # No PSA equivalent - needed by some init tests
1112 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001113 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001114 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001115
1116 # Compare reality with expectation.
1117 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001118 #
1119 # The output should be empty. When it's not:
1120 # - Each '+' line is a macro that was found but not expected. You want to
1121 # find where that macro occurs, and either replace it with PSA macros, or
1122 # add it to the exceptions list above with a justification.
1123 # - Each '-' line is a macro that was expected but not found; it means the
1124 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001125 diff -U0 $expected $found
1126
1127 rm $found $expected
1128}
1129
Gilles Peskine8f073122018-11-27 15:58:47 +01001130component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001131 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001132 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001133}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001134
Gilles Peskine192c72f2017-12-21 15:59:21 +01001135
Gilles Peskine636c26a2020-03-04 20:46:15 +01001136
Gilles Peskine192c72f2017-12-21 15:59:21 +01001137################################################################
1138#### Build and test many configurations and targets
1139################################################################
1140
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001141component_test_default_out_of_box () {
1142 msg "build: make, default config (out-of-box)" # ~1min
1143 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001144 # Disable fancy stuff
1145 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001146
1147 msg "test: main suites make, default config (out-of-box)" # ~10s
1148 make test
1149
1150 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001151 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001152
1153 msg "program demos: make, default config (out-of-box)" # ~10s
1154 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001155}
1156
Gilles Peskine8f073122018-11-27 15:58:47 +01001157component_test_default_cmake_gcc_asan () {
1158 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001159 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1160 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001161
Gilles Peskine8f073122018-11-27 15:58:47 +01001162 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1163 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001164
Gilles Peskine82b27272019-06-14 18:27:03 +02001165 msg "program demos (ASan build)" # ~10s
1166 tests/scripts/run_demos.py
1167
Gilles Peskine97bea012020-04-23 23:37:45 +02001168 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001169 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001170
Gilles Peskine6848d172023-11-02 19:58:03 +01001171 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001172 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001173
Gilles Peskine8f073122018-11-27 15:58:47 +01001174 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001175 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001176
Gilles Peskine8f073122018-11-27 15:58:47 +01001177 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001178 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001179
1180 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001181 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001182}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001183
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001184component_test_default_cmake_gcc_asan_new_bignum () {
1185 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001186 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001187 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001188 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001189
1190 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1191 make test
1192
1193 msg "test: selftest (ASan build)" # ~ 10s
1194 programs/test/selftest
1195
1196 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1197 tests/ssl-opt.sh
1198
1199 msg "test: compat.sh (ASan build)" # ~ 6 min
1200 tests/compat.sh
1201
1202 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1203 tests/context-info.sh
1204}
1205
Hanno Becker01635512019-02-26 14:27:09 +00001206component_test_full_cmake_gcc_asan () {
1207 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001208 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001209 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1210 make
1211
1212 msg "test: main suites (inc. selftests) (full config, ASan build)"
1213 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001214
Gilles Peskine97bea012020-04-23 23:37:45 +02001215 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001216 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001217
Gilles Peskine636c26a2020-03-04 20:46:15 +01001218 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001219 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001220
Manuel Pégourié-Gonnarde7987b62024-04-17 12:30:05 +02001221 msg "test: compat.sh: NULL (full config, ASan build)"
1222 tests/compat.sh -f 'NULL'
1223
1224 msg "test: compat.sh next: all except NULL (full config, ASan build)"
1225 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e 'NULL'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001226
1227 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001228 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001229}
1230
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001231
1232component_test_full_cmake_gcc_asan_new_bignum () {
1233 msg "build: full config, cmake, gcc, ASan"
1234 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001235 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001236 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001237 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001238
1239 msg "test: main suites (inc. selftests) (full config, ASan build)"
1240 make test
1241
1242 msg "test: selftest (ASan build)" # ~ 10s
1243 programs/test/selftest
1244
1245 msg "test: ssl-opt.sh (full config, ASan build)"
1246 tests/ssl-opt.sh
1247
Manuel Pégourié-Gonnarde7987b62024-04-17 12:30:05 +02001248 msg "test: compat.sh: NULL (full config, ASan build)"
1249 tests/compat.sh -f 'NULL'
1250
1251 msg "test: compat.sh next: all except NULL (full config, ASan build)"
1252 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e 'NULL'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001253
1254 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1255 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001256}
1257
Ronald Cronc3623db2020-10-29 10:51:32 +01001258component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001259 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001260 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001261 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1262 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1263 make
1264
1265 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1266 make test
1267}
1268
David Horstmann4a48bec2024-03-13 15:42:31 +00001269component_test_psa_assume_exclusive_buffers () {
1270 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001271 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001272 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001273 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1274 make
1275
David Horstmann4a48bec2024-03-13 15:42:31 +00001276 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001277 make test
1278}
1279
Gilles Peskinea3548672021-06-17 11:37:52 +02001280# check_renamed_symbols HEADER LIB
1281# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1282# name is LIB.
1283check_renamed_symbols () {
1284 ! nm "$2" | sed 's/.* //' |
1285 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1286}
1287
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001288component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001289 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001290 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001291 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1292 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1293 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1294 # We can only compile, not link, since our test and sample programs
1295 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1296 # is active.
1297 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001298
1299 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1300 # version is not present.
1301 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001302 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001303}
1304
Valerio Setti63097752024-03-12 13:18:13 +01001305# Get a list of library-wise undefined symbols and ensure that they only
1306# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1307# This function is a common helper used by both:
1308# - component_test_default_psa_crypto_client_without_crypto_provider
1309# - component_build_full_psa_crypto_client_without_crypto_provider.
1310common_check_mbedtls_missing_symbols() {
1311 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1312 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1313 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1314 not grep mbedtls_ linking_errors.txt
1315
1316 rm sym_def.txt sym_undef.txt linking_errors.txt
1317}
1318
1319component_test_default_psa_crypto_client_without_crypto_provider () {
1320 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1321
Ronald Cron336678b2021-01-28 17:54:24 +01001322 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1323 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001324 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001325 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001326 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001327 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001328
Ronald Cron336678b2021-01-28 17:54:24 +01001329 make
1330
Valerio Setti63097752024-03-12 13:18:13 +01001331 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1332 common_check_mbedtls_missing_symbols
1333
1334 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001335 make test
1336}
1337
Valerio Setti63097752024-03-12 13:18:13 +01001338component_build_full_psa_crypto_client_without_crypto_provider () {
1339 msg "build: full config - PSA_CRYPTO_C"
1340
1341 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1342 scripts/config.py full
1343
1344 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1345 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1346 # Dynamic secure element support is a deprecated feature and it is not
1347 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1348 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1349
1350 # Since there is no crypto provider in this build it is not possible to
1351 # build all the test executables and progrems due to missing PSA functions
1352 # at link time. Therefore we will just build libraries and we'll check
1353 # that symbols of interest are there.
1354 make lib
1355
1356 msg "check missing symbols: full config - PSA_CRYPTO_C"
1357
1358 common_check_mbedtls_missing_symbols
1359
1360 # Ensure that desired functions are included into the build (extend the
1361 # following list as required).
1362 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1363 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1364 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1365}
1366
Jaeden Amero424fa932021-05-14 08:34:32 +01001367component_test_psa_crypto_rsa_no_genprime() {
1368 msg "build: default config minus MBEDTLS_GENPRIME"
1369 scripts/config.py unset MBEDTLS_GENPRIME
1370 make
1371
1372 msg "test: default config minus MBEDTLS_GENPRIME"
1373 make test
1374}
1375
Gilles Peskine782f4112018-11-27 16:11:09 +01001376component_test_ref_configs () {
1377 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001378 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1379 # want to re-generate generated files that depend on it, quite correctly.
1380 # However this doesn't work as the generation script expects a specific
1381 # format for mbedtls_config.h, which the other files don't follow. Also,
1382 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001383 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001384 # whether they're on or off. So, disable cmake's (over-sensitive here)
1385 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001386 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001387 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001388 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001389}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001390
Gilles Peskine8f073122018-11-27 15:58:47 +01001391component_test_no_renegotiation () {
1392 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001393 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001394 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001395 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001396
Gilles Peskine8f073122018-11-27 15:58:47 +01001397 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1398 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001399
Gilles Peskine8f073122018-11-27 15:58:47 +01001400 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001401 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001402}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001403
Gilles Peskine636c26a2020-03-04 20:46:15 +01001404component_test_no_pem_no_fs () {
1405 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1406 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1407 scripts/config.py unset MBEDTLS_FS_IO
1408 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1409 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001410 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001411 make
1412
1413 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1414 make test
1415
1416 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001417 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001418}
1419
Gilles Peskine8f073122018-11-27 15:58:47 +01001420component_test_rsa_no_crt () {
1421 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001422 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001423 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001424 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001425
Gilles Peskine8f073122018-11-27 15:58:47 +01001426 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1427 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001428
Gilles Peskine8f073122018-11-27 15:58:47 +01001429 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001430 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001431
Gilles Peskine8f073122018-11-27 15:58:47 +01001432 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001433 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001434
1435 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001436 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001437}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001438
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001439component_test_no_ctr_drbg_classic () {
1440 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001441 scripts/config.py full
1442 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001443 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001444 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001445
Dave Rodgman17127e92023-12-14 16:42:48 +00001446 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001447 make
1448
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001449 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001450 make test
1451
Gilles Peskineba749042021-01-13 20:02:03 +01001452 # In this configuration, the TLS test programs use HMAC_DRBG.
1453 # The SSL tests are slow, so run a small subset, just enough to get
1454 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001455 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001456 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001457
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001458 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001459 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001460}
1461
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001462component_test_no_ctr_drbg_use_psa () {
1463 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001464 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001465 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1466 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001467
Dave Rodgman17127e92023-12-14 16:42:48 +00001468 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001469 make
1470
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001471 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1472 make test
1473
1474 # In this configuration, the TLS test programs use HMAC_DRBG.
1475 # The SSL tests are slow, so run a small subset, just enough to get
1476 # confidence that the SSL code copes with HMAC_DRBG.
1477 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001478 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001479
1480 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001481 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001482}
1483
1484component_test_no_hmac_drbg_classic () {
1485 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1486 scripts/config.py full
1487 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1488 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1489 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001490 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001491
Dave Rodgman17127e92023-12-14 16:42:48 +00001492 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001493 make
1494
1495 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001496 make test
1497
Gilles Peskinea2224342020-11-19 22:14:34 +01001498 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1499 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1500 # instead.
1501 # Test SSL with non-deterministic ECDSA. Only test features that
1502 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001503 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001504 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001505
1506 # To save time, only test one protocol version, since this part of
1507 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001508 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001509 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001510}
1511
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512component_test_no_hmac_drbg_use_psa () {
1513 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1514 scripts/config.py full
1515 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1516 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1517 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1518
Dave Rodgman17127e92023-12-14 16:42:48 +00001519 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001520 make
1521
1522 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1523 make test
1524
1525 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1526 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1527 # instead.
1528 # Test SSL with non-deterministic ECDSA. Only test features that
1529 # might be affected by how ECDSA signature is performed.
1530 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001531 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001532
1533 # To save time, only test one protocol version, since this part of
1534 # the protocol is identical in (D)TLS up to 1.2.
1535 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001536 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001537}
1538
1539component_test_psa_external_rng_no_drbg_classic () {
1540 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1541 scripts/config.py full
1542 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001543 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001544 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001545 scripts/config.py unset MBEDTLS_ENTROPY_C
1546 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1547 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001548 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1549 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1550 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001551 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1552 # the SSL test programs don't have an RNG and can't work. Explicitly
1553 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001554 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555
1556 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1557 make test
1558
Gilles Peskine8eb29432021-02-03 20:07:11 +01001559 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001560 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001561}
1562
1563component_test_psa_external_rng_no_drbg_use_psa () {
1564 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001565 scripts/config.py full
1566 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001567 scripts/config.py unset MBEDTLS_ENTROPY_C
1568 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1569 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001570 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1571 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1572 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001573 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001574
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001575 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001576 make test
1577
Gilles Peskine8eb29432021-02-03 20:07:11 +01001578 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001579 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001580}
1581
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001582component_test_psa_external_rng_use_psa_crypto () {
1583 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1584 scripts/config.py full
1585 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1586 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1587 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001588 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001589
1590 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1591 make test
1592
1593 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1594 tests/ssl-opt.sh -f 'Default\|opaque'
1595}
1596
Gilles Peskine801c4332023-04-28 21:04:28 +02001597component_test_psa_inject_entropy () {
1598 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1599 scripts/config.py full
1600 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1601 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1602 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1603 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1604 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1605 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001606 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 +02001607
1608 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1609 make test
1610}
1611
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001612component_test_sw_inet_pton () {
1613 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1614
1615 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1616 scripts/config.py set MBEDTLS_TEST_HOOKS
1617 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1618
1619 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1620 make test
1621}
1622
Valerio Settia41654d2024-02-08 10:33:11 +01001623component_full_no_pkparse_pkwrite() {
1624 msg "build: full without pkparse and pkwrite"
1625
1626 scripts/config.py crypto_full
1627 scripts/config.py unset MBEDTLS_PK_PARSE_C
1628 scripts/config.py unset MBEDTLS_PK_WRITE_C
1629
Valerio Settia41654d2024-02-08 10:33:11 +01001630 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1631
1632 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1633 not grep mbedtls_pk_parse_key library/pkparse.o
1634 not grep mbedtls_pk_write_key_der library/pkwrite.o
1635
1636 msg "test: full without pkparse and pkwrite"
1637 make test
1638}
1639
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001640component_test_crypto_full_md_light_only () {
1641 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001642 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001643 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001644 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001645 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001646 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001647 scripts/config.py unset MBEDTLS_HKDF_C
1648 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001649 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001650 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001651 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001652 # Disable things that would auto-enable MD_C
1653 scripts/config.py unset MBEDTLS_PKCS5_C
1654
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001655 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1656 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001657 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001658
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001659 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001660 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001661 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001662
1663 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001664 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001665}
1666
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001667component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001668 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001669 scripts/config.py full
1670 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001671 # Don't pull in cipher via PSA mechanisms
1672 # (currently ignored anyway because we completely disable PSA)
1673 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001674 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001675 scripts/config.py unset MBEDTLS_CMAC_C
1676 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001677 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001678 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001679 scripts/config.py unset MBEDTLS_SSL_TLS_C
1680 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001681 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001682 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1683 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001684 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001685 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001686 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001687
Valerio Settidf17a102023-10-23 14:14:19 +02001688 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001689 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001690}
1691
Valerio Setti7e710e82023-08-25 09:14:15 +02001692# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001693# - component_test_full_no_cipher_with_psa_crypto
1694# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001695# It accepts 2 input parameters:
1696# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1697# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001698common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001699 USE_CRYPTO_CONFIG="$1"
1700 COMPONENT_DESCRIPTION="$2"
1701
1702 msg "build: $COMPONENT_DESCRIPTION"
1703
1704 scripts/config.py full
1705 scripts/config.py unset MBEDTLS_CIPHER_C
1706
1707 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001708 # The built-in implementation of the following algs/key-types depends
1709 # on CIPHER_C so we disable them.
1710 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1711 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001712 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001713 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1714 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1715 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1716 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1717 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1718 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1719 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1720 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001721 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001722 else
1723 # Don't pull in cipher via PSA mechanisms
1724 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001725 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1726 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1727 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001728 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001729 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001730 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001731 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001732
Gilles Peskine21570cf2023-12-22 11:49:50 +01001733 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001734
Valerio Setti7e710e82023-08-25 09:14:15 +02001735 # Ensure that CIPHER_C was not re-enabled
1736 not grep mbedtls_cipher_init library/cipher.o
1737
1738 msg "test: $COMPONENT_DESCRIPTION"
1739 make test
1740}
1741
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001742component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001743 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001744}
1745
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001746component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001747 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001748}
1749
Valerio Settibdfecb62023-11-07 15:37:20 +01001750component_test_full_no_ccm() {
1751 msg "build: full no PSA_WANT_ALG_CCM"
1752
1753 # Full config enables:
1754 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1755 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1756 scripts/config.py full
1757
1758 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1759 # enabled, but not used from TLS since USE_PSA is set.
1760 # This is helpful to ensure that TLS tests below have proper dependencies.
1761 #
1762 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1763 # PSA_WANT_ALG_CCM to be re-enabled.
1764 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1765
Gilles Peskine21570cf2023-12-22 11:49:50 +01001766 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001767
1768 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001769 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001770}
1771
1772component_test_full_no_ccm_star_no_tag() {
1773 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1774
1775 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1776 scripts/config.py full
1777
1778 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1779 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1780 # This basically disables all unauthenticated ciphers on the PSA side, while
1781 # keeping AEADs enabled.
1782 #
1783 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1784 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1785 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1786 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1787 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1788 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1789 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1790 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1791 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1792 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1793
Gilles Peskine21570cf2023-12-22 11:49:50 +01001794 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001795
1796 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001797 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001798
1799 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001800 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001801}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001802
Valerio Settie1655b82023-01-03 15:35:25 +01001803component_test_full_no_bignum () {
1804 msg "build: full minus bignum"
1805 scripts/config.py full
1806 scripts/config.py unset MBEDTLS_BIGNUM_C
1807 # Direct dependencies of bignum
1808 scripts/config.py unset MBEDTLS_ECP_C
1809 scripts/config.py unset MBEDTLS_RSA_C
1810 scripts/config.py unset MBEDTLS_DHM_C
1811 # Direct dependencies of ECP
1812 scripts/config.py unset MBEDTLS_ECDH_C
1813 scripts/config.py unset MBEDTLS_ECDSA_C
1814 scripts/config.py unset MBEDTLS_ECJPAKE_C
1815 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001816 # Disable what auto-enables ECP_LIGHT
1817 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1818 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001819 # Indirect dependencies of ECP
1820 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1821 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1822 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1823 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1824 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1825 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1826 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1827 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1828 # Direct dependencies of DHM
1829 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1830 # Direct dependencies of RSA
1831 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1832 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1833 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1834 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1835 # PK and its dependencies
1836 scripts/config.py unset MBEDTLS_PK_C
1837 scripts/config.py unset MBEDTLS_PK_PARSE_C
1838 scripts/config.py unset MBEDTLS_PK_WRITE_C
1839 scripts/config.py unset MBEDTLS_X509_USE_C
1840 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1841 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1842 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1843 scripts/config.py unset MBEDTLS_X509_CREATE_C
1844 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1845 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1846 scripts/config.py unset MBEDTLS_PKCS7_C
1847 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1848 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1849 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1850
Gilles Peskine21570cf2023-12-22 11:49:50 +01001851 make
Valerio Settie1655b82023-01-03 15:35:25 +01001852
1853 msg "test: full minus bignum"
1854 make test
1855}
1856
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001857component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001858 msg "build: default with only stream cipher"
1859
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001860 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001861 scripts/config.py unset MBEDTLS_GCM_C
1862 scripts/config.py unset MBEDTLS_CCM_C
1863 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001864 #Disable TLS 1.3 (as no AEAD)
1865 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001866 # 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 +02001867 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001868 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001869 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001870 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1871 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001872 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001873 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001874 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001875
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001876 make
1877
1878 msg "test: default with only stream cipher"
1879 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001880
1881 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001882}
1883
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001884component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001885 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001886
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001887 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001888 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001889 scripts/config.py unset MBEDTLS_GCM_C
1890 scripts/config.py unset MBEDTLS_CCM_C
1891 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001892 #Disable TLS 1.3 (as no AEAD)
1893 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001894 # 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 +02001895 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001896 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001897 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001898 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1899 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001900 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001901 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001902 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001903
Przemek Stekiel9550c052022-09-28 09:51:55 +02001904 make
1905
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001906 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001907 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001908
1909 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001910}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001911
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001912component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001913 msg "build: default with only CBC-legacy cipher"
1914
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001915 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001916 scripts/config.py unset MBEDTLS_GCM_C
1917 scripts/config.py unset MBEDTLS_CCM_C
1918 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001919 #Disable TLS 1.3 (as no AEAD)
1920 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001921 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1922 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1923 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001924 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001925 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001926 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001927 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001928 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001929 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001930
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001931 make
1932
1933 msg "test: default with only CBC-legacy cipher"
1934 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001935
1936 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1937 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001938}
1939
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001940component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001941 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001942
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001943 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001944 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001945 scripts/config.py unset MBEDTLS_GCM_C
1946 scripts/config.py unset MBEDTLS_CCM_C
1947 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001948 #Disable TLS 1.3 (as no AEAD)
1949 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001950 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1951 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1952 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001953 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001954 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001955 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001956 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001957 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001958 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001959
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001960 make
1961
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001962 msg "test: default with only CBC-legacy cipher use psa"
1963 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001964
1965 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1966 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001967}
1968
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001969component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001970 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1971
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001972 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001973 scripts/config.py unset MBEDTLS_GCM_C
1974 scripts/config.py unset MBEDTLS_CCM_C
1975 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001976 #Disable TLS 1.3 (as no AEAD)
1977 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001978 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1979 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1980 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1981 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1982 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001983 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001984 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001985 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001986 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001987
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001988 make
1989
1990 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1991 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001992
1993 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1994 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001995}
1996
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001997component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1998 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001999
2000 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002001 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002002 scripts/config.py unset MBEDTLS_GCM_C
2003 scripts/config.py unset MBEDTLS_CCM_C
2004 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002005 #Disable TLS 1.3 (as no AEAD)
2006 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002007 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2008 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2009 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2010 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2011 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002012 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002013 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002014 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002015 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002016
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002017 make
2018
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002019 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002020 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002021
2022 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2023 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002024}
2025
Valerio Setti9f0ec532022-11-08 13:03:24 +01002026# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2027# that we could use for interop testing. However, we now have sort of two
2028# implementations ourselves: one using PSA, the other not. At least test that
2029# these two interoperate with each other.
2030component_test_tls1_2_ecjpake_compatibility() {
2031 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2032 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002033 # Explicitly make lib first to avoid a race condition:
2034 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2035 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002036 make -C programs ssl/ssl_server2 ssl/ssl_client2
2037 cp programs/ssl/ssl_server2 s2_no_use_psa
2038 cp programs/ssl/ssl_client2 c2_no_use_psa
2039
2040 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2041 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2042 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002043 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002044 make -C programs ssl/ssl_server2 ssl/ssl_client2
2045 make -C programs test/udp_proxy test/query_compile_time_config
2046
Valerio Setti70e02902022-12-02 16:21:56 +01002047 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2048 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2049 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2050 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2051 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2052 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2053 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2054 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 +01002055
2056 rm s2_no_use_psa c2_no_use_psa
2057}
2058
Gilles Peskine636c26a2020-03-04 20:46:15 +01002059component_test_everest () {
2060 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2061 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2062 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2063 make
2064
2065 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2066 make test
2067
Gilles Peskine6848d172023-11-02 19:58:03 +01002068 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002069 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002070
Gilles Peskine636c26a2020-03-04 20:46:15 +01002071 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2072 tests/ssl-opt.sh -f ECDH
2073
2074 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2075 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002076 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002077}
2078
Gilles Peskined3beca92020-07-03 00:15:37 +02002079component_test_everest_curve25519_only () {
2080 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002081 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2082 scripts/config.py unset MBEDTLS_ECDSA_C
2083 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2084 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002085 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002086 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002087 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002088 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2089
Dave Rodgman17127e92023-12-14 16:42:48 +00002090 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002091
2092 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2093 make test
2094}
2095
Gilles Peskine8f073122018-11-27 15:58:47 +01002096component_test_small_ssl_out_content_len () {
2097 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002098 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2099 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002100 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002101 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002102
Gilles Peskine8f073122018-11-27 15:58:47 +01002103 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002104 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002105}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002106
Gilles Peskine8f073122018-11-27 15:58:47 +01002107component_test_small_ssl_in_content_len () {
2108 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002109 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2110 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002111 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002112 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002113
Gilles Peskine8f073122018-11-27 15:58:47 +01002114 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002115 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002116}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002117
Gilles Peskine8f073122018-11-27 15:58:47 +01002118component_test_small_ssl_dtls_max_buffering () {
2119 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002120 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002121 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002122 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002123
Gilles Peskine8f073122018-11-27 15:58:47 +01002124 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002125 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 +01002126}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002127
Gilles Peskine8f073122018-11-27 15:58:47 +01002128component_test_small_mbedtls_ssl_dtls_max_buffering () {
2129 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002130 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002131 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002132 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002133
Gilles Peskine8f073122018-11-27 15:58:47 +01002134 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002135 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002136}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002137
Gilles Peskine75cc7712019-09-06 19:47:17 +02002138component_test_psa_collect_statuses () {
2139 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002140 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002141 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002142 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002143 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002144 rm -f tests/statuses.log
2145}
2146
Gilles Peskine8f073122018-11-27 15:58:47 +01002147component_test_full_cmake_clang () {
2148 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002149 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002150 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 +01002151 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002152
k-stachowiak0291cb72019-06-26 15:52:12 +02002153 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002154 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002155
Gilles Peskineda6017c2022-10-30 21:02:40 +01002156 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2157 programs/test/cpp_dummy_build
2158
Gilles Peskine6848d172023-11-02 19:58:03 +01002159 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002160 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002161
Gilles Peskine82b27272019-06-14 18:27:03 +02002162 msg "program demos (full config, clang)" # ~10s
2163 tests/scripts/run_demos.py
2164
k-stachowiak0291cb72019-06-26 15:52:12 +02002165 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002166 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002167
Gilles Peskine8f073122018-11-27 15:58:47 +01002168 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002169 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002170}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002171
Gilles Peskine0c671602022-11-29 16:01:41 +01002172skip_suites_without_constant_flow () {
2173 # Skip the test suites that don't have any constant-flow annotations.
2174 # This will need to be adjusted if we ever start declaring things as
2175 # secret from macros or functions inside tests/include or tests/src.
2176 SKIP_TEST_SUITES=$(
2177 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2178 sed 's/test_suite_//; s/\.function$//' |
2179 tr '\n' ,)
2180 export SKIP_TEST_SUITES
2181}
2182
Dave Rodgman246210e2023-07-31 18:07:44 +01002183skip_all_except_given_suite () {
2184 # Skip all but the given test suite
2185 SKIP_TEST_SUITES=$(
2186 ls -1 tests/suites/test_suite_*.function |
2187 grep -v $1.function |
2188 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2189 tr '\n' ,)
2190 export SKIP_TEST_SUITES
2191}
2192
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002193component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002194 # This tests both (1) accesses to undefined memory, and (2) branches or
2195 # memory access depending on secret values. To distinguish between those:
2196 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2197 # - or alternatively, change the build type to MemSanDbg, which enables
2198 # origin tracking and nicer stack traces (which are useful for debugging
2199 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002200 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2201 scripts/config.py full
2202 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2203 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2204 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2205 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2206 make
2207
2208 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2209 make test
2210}
2211
2212component_test_memsan_constant_flow_psa () {
2213 # This tests both (1) accesses to undefined memory, and (2) branches or
2214 # memory access depending on secret values. To distinguish between those:
2215 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2216 # - or alternatively, change the build type to MemSanDbg, which enables
2217 # origin tracking and nicer stack traces (which are useful for debugging
2218 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002219 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002220 scripts/config.py full
2221 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2222 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2223 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2224 make
2225
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002226 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002227 make test
2228}
2229
Bence Szépkúti0354d042023-12-06 16:14:37 +01002230component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002231 # This tests both (1) everything that valgrind's memcheck usually checks
2232 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2233 # etc.) and (2) branches or memory access depending on secret values,
2234 # which will be reported as uninitialized memory. To distinguish between
2235 # secret and actually uninitialized:
2236 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2237 # - or alternatively, build with debug info and manually run the offending
2238 # test suite with valgrind --track-origins=yes, then check if the origin
2239 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002240 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2241 scripts/config.py full
2242 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2243 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002244 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002245 cmake -D CMAKE_BUILD_TYPE:String=Release .
2246 make
2247
2248 # this only shows a summary of the results (how many of each type)
2249 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002250 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002251 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002252
2253 # Test asm path in constant time module - by default, it will test the plain C
2254 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2255 msg "test: valgrind asm constant_time"
2256 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2257 skip_all_except_given_suite test_suite_constant_time
2258 cmake -D CMAKE_BUILD_TYPE:String=Release .
2259 make clean
2260 make
2261 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002262}
2263
Bence Szépkúti0354d042023-12-06 16:14:37 +01002264component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002265 # This tests both (1) everything that valgrind's memcheck usually checks
2266 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2267 # etc.) and (2) branches or memory access depending on secret values,
2268 # which will be reported as uninitialized memory. To distinguish between
2269 # secret and actually uninitialized:
2270 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2271 # - or alternatively, build with debug info and manually run the offending
2272 # test suite with valgrind --track-origins=yes, then check if the origin
2273 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002274 msg "build: cmake release GCC, full config with constant flow testing"
2275 scripts/config.py full
2276 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002277 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002278 cmake -D CMAKE_BUILD_TYPE:String=Release .
2279 make
2280
2281 # this only shows a summary of the results (how many of each type)
2282 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002283 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002284 make memcheck
2285}
2286
Janos Follath9338cac2023-10-04 18:55:39 +01002287component_test_tsan () {
2288 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002289 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002290 scripts/config.py set MBEDTLS_THREADING_C
2291 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002292 # Self-tests do not currently use multiple threads.
2293 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002294
Ryan6caf84f2024-03-05 13:57:00 +00002295 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2296 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2297
Janos Follath9338cac2023-10-04 18:55:39 +01002298 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2299 make
2300
2301 msg "test: main suites (TSan)"
2302 make test
2303}
2304
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002305component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002306 # Test that removing the deprecated features from the default
2307 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002308 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2309 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002310 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002311
2312 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2313 make test
2314}
2315
2316component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002317 msg "build: make, full_no_deprecated config" # ~ 30s
2318 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002319 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002320
Gilles Peskine30de2e82020-04-20 21:39:22 +02002321 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002322 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002323
2324 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2325 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002326}
2327
Gilles Peskine8386ea22020-04-30 09:07:29 +02002328component_test_full_no_deprecated_deprecated_warning () {
2329 # Test that there is nothing deprecated in "full_no_deprecated".
2330 # A deprecated feature would trigger a warning (made fatal) from
2331 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002332 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2333 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002334 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2335 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002336 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002337
Gilles Peskine30de2e82020-04-20 21:39:22 +02002338 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002339 make test
2340}
2341
Gilles Peskine8386ea22020-04-30 09:07:29 +02002342component_test_full_deprecated_warning () {
2343 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2344 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002345 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002346 scripts/config.py full
2347 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002348 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002349 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2350 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002351 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002352
Gilles Peskine8386ea22020-04-30 09:07:29 +02002353 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2354 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2355 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002356 # Expect warnings from '#warning' directives in check_config.h and
2357 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002358 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 +01002359
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002360 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2361 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002362
2363 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2364 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002365}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002366
Gilles Peskineec541fe2020-01-31 14:24:14 +01002367# Check that the specified libraries exist and are empty.
2368are_empty_libraries () {
2369 nm "$@" >/dev/null 2>/dev/null
2370 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2371}
2372
2373component_build_crypto_default () {
2374 msg "build: make, crypto only"
2375 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002376 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002377 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002378}
2379
2380component_build_crypto_full () {
2381 msg "build: make, crypto only, full config"
2382 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002383 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002384 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002385}
2386
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002387component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002388 msg "build: make, config for PSA crypto service"
2389 scripts/config.py crypto
2390 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2391 # Disable things that are not needed for just cryptography, to
2392 # reach a configuration that would be typical for a PSA cryptography
2393 # service providing all implemented PSA algorithms.
2394 # System stuff
2395 scripts/config.py unset MBEDTLS_ERROR_C
2396 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002397 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002398 # Crypto stuff with no PSA interface
2399 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002400 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002401 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002402 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002403 scripts/config.py unset MBEDTLS_NIST_KW_C
2404 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2405 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2406 scripts/config.py unset MBEDTLS_PKCS12_C
2407 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002408 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2409 # in PSA code to work with RSA keys. We don't require users to set those:
2410 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002411 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002412 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002413 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002414 make CFLAGS='-O1 -Werror' all test
2415 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2416}
2417
Gilles Peskineec541fe2020-01-31 14:24:14 +01002418component_build_crypto_baremetal () {
2419 msg "build: make, crypto only, baremetal config"
2420 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002421 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002422 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002423}
Daniel Axtens446af202020-09-02 21:30:13 +10002424support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002425 support_build_baremetal "$@"
2426}
2427
2428component_build_baremetal () {
2429 msg "build: make, baremetal config"
2430 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002431 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002432}
2433support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002434 # Older Glibc versions include time.h from other headers such as stdlib.h,
2435 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2436 # problem, Ubuntu 18.04 is ok.
2437 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2438}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002439
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002440# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002441component_test_depends_py_cipher_id () {
2442 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002443 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002444}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002445
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002446component_test_depends_py_cipher_chaining () {
2447 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002448 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002449}
2450
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002451component_test_depends_py_cipher_padding () {
2452 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002453 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002454}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002455
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002456component_test_depends_py_curves () {
2457 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002458 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002459}
2460
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002461component_test_depends_py_hashes () {
2462 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002463 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002464}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002465
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002466component_test_depends_py_kex () {
2467 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002468 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002469}
2470
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002471component_test_depends_py_pkalgs () {
2472 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002473 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002474}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002475
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002476# PSA equivalents of the depends.py tests
2477component_test_depends_py_cipher_id_psa () {
2478 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002479 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002480}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002481
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002482component_test_depends_py_cipher_chaining_psa () {
2483 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002484 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002485}
2486
2487component_test_depends_py_cipher_padding_psa () {
2488 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002489 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002490}
2491
2492component_test_depends_py_curves_psa () {
2493 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002494 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002495}
2496
2497component_test_depends_py_hashes_psa () {
2498 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002499 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002500}
2501
2502component_test_depends_py_kex_psa () {
2503 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002504 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002505}
2506
2507component_test_depends_py_pkalgs_psa () {
2508 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002509 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002510}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002511
Valerio Setti6bed64e2024-01-17 15:21:44 +01002512component_test_psa_crypto_config_ffdh_2048_only () {
2513 msg "build: full config - only DH 2048"
2514
2515 scripts/config.py full
2516
2517 # Disable all DH groups other than 2048.
2518 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2519 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2520 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2521 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2522
2523 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2524
2525 msg "test: full config - only DH 2048"
2526 make test
2527
2528 msg "ssl-opt: full config - only DH 2048"
2529 tests/ssl-opt.sh -f "ffdh"
2530}
2531
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002532component_build_no_pk_rsa_alt_support () {
2533 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2534
2535 scripts/config.py full
2536 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2537 scripts/config.py set MBEDTLS_RSA_C
2538 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2539
2540 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002541 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002542}
2543
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002544component_build_module_alt () {
2545 msg "build: MBEDTLS_XXX_ALT" # ~30s
2546 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002547
2548 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002549 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2550 scripts/config.py unset MBEDTLS_AESNI_C
2551 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002552 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002553 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2554 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002555 # You can only have one threading implementation: alt or pthread, not both.
2556 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002557 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2558 # directly and assumes the implementation works with partial groups.
2559 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002560 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2561 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2562 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002563 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2564 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2565 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002566
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002567 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2568 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2569 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002570 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002571
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002572 # We can only compile, not link, since we don't have any implementations
2573 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002574 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002575}
2576
2577component_build_dhm_alt () {
2578 msg "build: MBEDTLS_DHM_ALT" # ~30s
2579 scripts/config.py full
2580 scripts/config.py set MBEDTLS_DHM_ALT
2581 # debug.c currently references mbedtls_dhm_context fields directly.
2582 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002583 # We can only compile, not link, since we don't have any implementations
2584 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002585 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002586}
2587
Gilles Peskine64996c32024-01-23 20:25:47 +01002588component_test_no_psa_crypto_full_cmake_asan() {
2589 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2590 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002591 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002592 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002593 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002594 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002595 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002596 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002597 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002598 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002599 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002600 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002601 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002602 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002603
Gilles Peskine64996c32024-01-23 20:25:47 +01002604 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002605 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002606
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002607 # Note: ssl-opt.sh has some test cases that depend on
2608 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2609 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002610 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002611 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002612
Manuel Pégourié-Gonnarde7987b62024-04-17 12:30:05 +02002613 msg "test: compat.sh: NULL (full minus PSA crypto)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002614 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002615
Manuel Pégourié-Gonnarde7987b62024-04-17 12:30:05 +02002616 msg "test: compat.sh next: all except NULL (full minus PSA crypto)"
2617 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e 'NULL'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002618}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002619
Ronald Cron403c15c2021-09-13 09:38:05 +02002620component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002621 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002622
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002623 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002624 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002625 $(helper_get_psa_key_type_list "ECC") \
2626 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002627
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002628 # Configure
2629 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002630
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002631 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002632 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002633
2634 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002635 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002636
2637 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002638 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2639 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2640
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002641 # Build
2642 # -----
2643
2644 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002645 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2646 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002647
2648 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2649
Valerio Setti3fe105b2023-10-30 11:08:12 +01002650 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002651
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002652 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002653 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002654
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002655 # Run the tests
2656 # -------------
2657
Ronald Cron403c15c2021-09-13 09:38:05 +02002658 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2659 make test
2660}
2661
Valerio Setti44b178c2023-03-22 14:02:57 +01002662component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002663 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002664
2665 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002666 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002667 $(helper_get_psa_key_type_list "ECC") \
2668 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002669
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002670 # Configure
2671 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002672
Ronald Cron46ac0652024-03-18 12:39:04 +01002673 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002674 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002675
Valerio Setti44b178c2023-03-22 14:02:57 +01002676 # Disable the module that's accelerated
2677 scripts/config.py unset MBEDTLS_ECDH_C
2678
2679 # Disable things that depend on it
2680 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2682 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2683 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2684 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2685
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002686 # Build
2687 # -----
2688
2689 helper_libtestdriver1_make_drivers "$loc_accel_list"
2690
Valerio Setti3fe105b2023-10-30 11:08:12 +01002691 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002692
Valerio Setti44b178c2023-03-22 14:02:57 +01002693 # Make sure this was not re-enabled by accident (additive config)
2694 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002695
2696 # Run the tests
2697 # -------------
2698
Valerio Setti44b178c2023-03-22 14:02:57 +01002699 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002700 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002701}
2702
Przemek Stekieldccb2022023-05-11 10:48:50 +02002703component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002704 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002705
2706 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002707 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002708 $(helper_get_psa_key_type_list "DH") \
2709 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002710
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002711 # Configure
2712 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002713
Przemek Stekiel565353e2023-07-05 11:07:07 +02002714 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002715 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002716
2717 # Disable the module that's accelerated
2718 scripts/config.py unset MBEDTLS_DHM_C
2719
2720 # Disable things that depend on it
2721 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2722 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2723
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002724 # Build
2725 # -----
2726
2727 helper_libtestdriver1_make_drivers "$loc_accel_list"
2728
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002729 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002730
2731 # Make sure this was not re-enabled by accident (additive config)
2732 not grep mbedtls_dhm_ library/dhm.o
2733
2734 # Run the tests
2735 # -------------
2736
Gilles Peskine14302ed2023-07-19 19:30:04 +02002737 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002738 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002739
Gilles Peskine14302ed2023-07-19 19:30:04 +02002740 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002741 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002742}
2743
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002744component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002745 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002746
2747 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002748 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002749
2750 # Disable things that are not supported
2751 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2752 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002753 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002754
Gilles Peskine14302ed2023-07-19 19:30:04 +02002755 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002756 make test
2757
Gilles Peskine14302ed2023-07-19 19:30:04 +02002758 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002759 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002760}
2761
Valerio Setti44b178c2023-03-22 14:02:57 +01002762component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002763 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002764
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002765 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002766 $(helper_get_psa_key_type_list "ECC") \
2767 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002768
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002769 # Configure
2770 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002771
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002772 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002773
2774 # Make built-in fallback not available
2775 scripts/config.py unset MBEDTLS_ECJPAKE_C
2776 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2777
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002778 # Build
2779 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002780
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002781 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002782
Valerio Setti3fe105b2023-10-30 11:08:12 +01002783 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002784
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002785 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002786 not grep mbedtls_ecjpake_init library/ecjpake.o
2787
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002788 # Run the tests
2789 # -------------
2790
Gilles Peskine14302ed2023-07-19 19:30:04 +02002791 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002792 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002793}
2794
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002795component_test_psa_crypto_config_accel_ecc_some_key_types () {
2796 msg "build: full with accelerated EC algs and some key types"
2797
2798 # Algorithms and key types to accelerate
2799 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2800 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2801 ALG_ECDH \
2802 ALG_JPAKE \
2803 KEY_TYPE_ECC_PUBLIC_KEY \
2804 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2805 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002806 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2807 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002808
2809 # Configure
2810 # ---------
2811
2812 # start with config full for maximum coverage (also enables USE_PSA)
2813 helper_libtestdriver1_adjust_config "full"
2814
2815 # Disable modules that are accelerated - some will be re-enabled
2816 scripts/config.py unset MBEDTLS_ECDSA_C
2817 scripts/config.py unset MBEDTLS_ECDH_C
2818 scripts/config.py unset MBEDTLS_ECJPAKE_C
2819 scripts/config.py unset MBEDTLS_ECP_C
2820
2821 # Disable all curves - those that aren't accelerated should be re-enabled
2822 helper_disable_builtin_curves
2823
2824 # Restartable feature is not yet supported by PSA. Once it will in
2825 # the future, the following line could be removed (see issues
2826 # 6061, 6332 and following ones)
2827 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2828
2829 # this is not supported by the driver API yet
2830 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2831
2832 # Build
2833 # -----
2834
2835 # These hashes are needed for some ECDSA signature tests.
2836 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2837 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2838 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2839
Valerio Setti3fe105b2023-10-30 11:08:12 +01002840 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002841
2842 # ECP should be re-enabled but not the others
2843 not grep mbedtls_ecdh_ library/ecdh.o
2844 not grep mbedtls_ecdsa library/ecdsa.o
2845 not grep mbedtls_ecjpake library/ecjpake.o
2846 grep mbedtls_ecp library/ecp.o
2847
2848 # Run the tests
2849 # -------------
2850
2851 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002852 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002853}
2854
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002855# Run tests with only (non-)Weierstrass accelerated
2856# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002857# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2858# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002859common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002860 weierstrass=$1
2861 if [ $weierstrass -eq 1 ]; then
2862 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002863 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002864 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002865 fi
2866
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002867 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002868
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002869 # Note: Curves are handled in a special way by the libtestdriver machinery,
2870 # so we only want to include them in the accel list when building the main
2871 # libraries, hence the use of a separate variable.
2872 # Note: the following loop is a modified version of
2873 # helper_get_psa_curve_list that only keeps Weierstrass families.
2874 loc_weierstrass_list=""
2875 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002876 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2877 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002878 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002879 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002880 ;;
2881 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002882 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002883 ;;
2884 esac
2885 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002886 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002887 loc_curve_list=$loc_weierstrass_list
2888 else
2889 loc_curve_list=$loc_non_weierstrass_list
2890 fi
2891
Valerio Setti3fe105b2023-10-30 11:08:12 +01002892 # Algorithms and key types to accelerate
2893 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2894 ALG_ECDH \
2895 ALG_JPAKE \
2896 $(helper_get_psa_key_type_list "ECC") \
2897 $loc_curve_list"
2898
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002899 # Configure
2900 # ---------
2901
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002902 # Start with config crypto_full and remove PK_C:
2903 # that's what's supported now, see docs/driver-only-builds.md.
2904 helper_libtestdriver1_adjust_config "crypto_full"
2905 scripts/config.py unset MBEDTLS_PK_C
2906 scripts/config.py unset MBEDTLS_PK_PARSE_C
2907 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002908
2909 # Disable modules that are accelerated - some will be re-enabled
2910 scripts/config.py unset MBEDTLS_ECDSA_C
2911 scripts/config.py unset MBEDTLS_ECDH_C
2912 scripts/config.py unset MBEDTLS_ECJPAKE_C
2913 scripts/config.py unset MBEDTLS_ECP_C
2914
2915 # Disable all curves - those that aren't accelerated should be re-enabled
2916 helper_disable_builtin_curves
2917
2918 # Restartable feature is not yet supported by PSA. Once it will in
2919 # the future, the following line could be removed (see issues
2920 # 6061, 6332 and following ones)
2921 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2922
2923 # this is not supported by the driver API yet
2924 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2925
2926 # Build
2927 # -----
2928
2929 # These hashes are needed for some ECDSA signature tests.
2930 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2931 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2932 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2933
Valerio Settiac7a8092023-10-31 12:23:44 +01002934 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002935
2936 # We expect ECDH to be re-enabled for the missing curves
2937 grep mbedtls_ecdh_ library/ecdh.o
2938 # We expect ECP to be re-enabled, however the parts specific to the
2939 # families of curves that are accelerated should be ommited.
2940 # - functions with mxz in the name are specific to Montgomery curves
2941 # - ecp_muladd is specific to Weierstrass curves
2942 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002943 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002944 not grep mbedtls_ecp_muladd library/ecp.o
2945 grep mxz library/ecp.o
2946 else
2947 grep mbedtls_ecp_muladd library/ecp.o
2948 not grep mxz library/ecp.o
2949 fi
2950 # We expect ECDSA and ECJPAKE to be re-enabled only when
2951 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002952 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002953 not grep mbedtls_ecdsa library/ecdsa.o
2954 not grep mbedtls_ecjpake library/ecjpake.o
2955 else
2956 grep mbedtls_ecdsa library/ecdsa.o
2957 grep mbedtls_ecjpake library/ecjpake.o
2958 fi
2959
2960 # Run the tests
2961 # -------------
2962
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002963 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2964 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002965}
2966
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002967component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002968 common_test_psa_crypto_config_accel_ecc_some_curves 1
2969}
2970
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002971component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002972 common_test_psa_crypto_config_accel_ecc_some_curves 0
2973}
2974
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002975# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2976# ECDH, ECDSA) with and without drivers.
2977# The input parameter is a boolean value which indicates:
2978# - 0 keep built-in EC algs,
2979# - 1 exclude built-in EC algs (driver only).
2980#
2981# This is used by the two following components to ensure they always use the
2982# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002983# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2984# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002985# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002986config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002987 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002988 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002989 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002990 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002991 # Disable modules that are accelerated
2992 scripts/config.py unset MBEDTLS_ECDSA_C
2993 scripts/config.py unset MBEDTLS_ECDH_C
2994 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002995 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002996 fi
2997
2998 # Restartable feature is not yet supported by PSA. Once it will in
2999 # the future, the following line could be removed (see issues
3000 # 6061, 6332 and following ones)
3001 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003002}
3003
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003004# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3005component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003006 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003007
3008 # Algorithms and key types to accelerate
3009 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3010 ALG_ECDH \
3011 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003012 $(helper_get_psa_key_type_list "ECC") \
3013 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003014
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003015 # Configure
3016 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003017
3018 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003019 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003020
Valerio Setti0a342c92023-09-01 09:12:31 +02003021 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003022 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3023 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003024
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003025 # Build
3026 # -----
3027
3028 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003029 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3030 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003031 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3032
Valerio Setti3fe105b2023-10-30 11:08:12 +01003033 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003034
3035 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3036 not grep mbedtls_ecdsa_ library/ecdsa.o
3037 not grep mbedtls_ecdh_ library/ecdh.o
3038 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003039 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003040
3041 # Run the tests
3042 # -------------
3043
Gilles Peskine14302ed2023-07-19 19:30:04 +02003044 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003045 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003046
Gilles Peskine14302ed2023-07-19 19:30:04 +02003047 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003048 tests/ssl-opt.sh
3049}
3050
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003051# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3052component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003053 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003054
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003055 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003056
Gilles Peskine21570cf2023-12-22 11:49:50 +01003057 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003058
Gilles Peskine14302ed2023-07-19 19:30:04 +02003059 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003060 make test
3061
Gilles Peskine14302ed2023-07-19 19:30:04 +02003062 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003063 tests/ssl-opt.sh
3064}
3065
Valerio Settie618cb02023-04-12 14:59:16 +02003066# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003067# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3068# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003069# to ensure that both tests use the same underlying configuration when testing
3070# driver's coverage with analyze_outcomes.py.
3071#
3072# This functions accepts 1 boolean parameter as follows:
3073# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3074# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3075# - 0: include built-in implementation of EC algorithms.
3076#
3077# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3078# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003079config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003080 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003081 # start with full config for maximum coverage (also enables USE_PSA)
3082 helper_libtestdriver1_adjust_config "full"
3083
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003084 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003085 # Disable modules that are accelerated
3086 scripts/config.py unset MBEDTLS_ECDSA_C
3087 scripts/config.py unset MBEDTLS_ECDH_C
3088 scripts/config.py unset MBEDTLS_ECJPAKE_C
3089 # Disable ECP module (entirely)
3090 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003091 fi
3092
Valerio Settiaecd32c2023-06-14 10:42:31 +02003093 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3094 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003095 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003096 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003097
Valerio Settie618cb02023-04-12 14:59:16 +02003098 # Restartable feature is not yet supported by PSA. Once it will in
3099 # the future, the following line could be removed (see issues
3100 # 6061, 6332 and following ones)
3101 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003102}
3103
3104# Build and test a configuration where driver accelerates all EC algs while
3105# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3106# side.
3107#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003108# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3109component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003110 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003111
3112 # Algorithms and key types to accelerate
3113 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3114 ALG_ECDH \
3115 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003116 $(helper_get_psa_key_type_list "ECC") \
3117 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003118
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003119 # Configure
3120 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003121
Valerio Settie618cb02023-04-12 14:59:16 +02003122 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003123 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003124 # Disable all the builtin curves. All the required algs are accelerated.
3125 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003126
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003127 # Build
3128 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003129
3130 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003131 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3132 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3133 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003134
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003135 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003136
Valerio Setti3fe105b2023-10-30 11:08:12 +01003137 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003138
3139 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3140 not grep mbedtls_ecdsa_ library/ecdsa.o
3141 not grep mbedtls_ecdh_ library/ecdh.o
3142 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003143 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003144 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003145
3146 # Run the tests
3147 # -------------
3148
Gilles Peskine14302ed2023-07-19 19:30:04 +02003149 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003150 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003151
Gilles Peskine14302ed2023-07-19 19:30:04 +02003152 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003153 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003154}
3155
3156# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003157# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003158# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003159component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003160 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003161
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003162 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003163
Gilles Peskine21570cf2023-12-22 11:49:50 +01003164 make
Valerio Settie618cb02023-04-12 14:59:16 +02003165
Gilles Peskine14302ed2023-07-19 19:30:04 +02003166 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003167 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003168
Gilles Peskine14302ed2023-07-19 19:30:04 +02003169 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003170 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003171}
3172
Valerio Setti4e2f2442023-08-15 10:10:26 +02003173# This is a common configuration helper used directly from:
3174# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3175# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3176# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003177# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003178# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003179# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003180# - this is the reference component of the above
3181# - it still disables RSA and FFDH, but it uses builtin EC algs
3182# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3183# - accelerate all EC and FFDH algs, disable only RSA
3184# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3185# - this is the reference component of the above
3186# - it still disables RSA, but it uses builtin EC and FFDH algs
3187#
3188# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003189# $1: a boolean value which states if we are testing an accelerated scenario
3190# or not.
3191# $2: a string value which states which components are tested. Allowed values
3192# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003193config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003194 driver_only="$1"
3195 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003196 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003197 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003198
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003199 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003200 # Disable modules that are accelerated
3201 scripts/config.py unset MBEDTLS_ECDSA_C
3202 scripts/config.py unset MBEDTLS_ECDH_C
3203 scripts/config.py unset MBEDTLS_ECJPAKE_C
3204 # Disable ECP module (entirely)
3205 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003206 # Also disable bignum
3207 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003208 fi
3209
3210 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3211 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3212 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3213 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3214
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003215 # RSA support is intentionally disabled on this test because RSA_C depends
3216 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003217 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3218 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 +02003219 scripts/config.py unset MBEDTLS_RSA_C
3220 scripts/config.py unset MBEDTLS_PKCS1_V15
3221 scripts/config.py unset MBEDTLS_PKCS1_V21
3222 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3223 # Also disable key exchanges that depend on RSA
3224 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3225 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3226 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3227 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3228 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3229
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003230 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003231 # When testing ECC only, we disable FFDH support, both from builtin and
3232 # PSA sides, and also disable the key exchanges that depend on DHM.
3233 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3234 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003235 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003236 scripts/config.py unset MBEDTLS_DHM_C
3237 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3238 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3239 else
3240 # When testing ECC and DH instead, we disable DHM and depending key
3241 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003242 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003243 scripts/config.py unset MBEDTLS_DHM_C
3244 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3245 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3246 fi
3247 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003248
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003249 # Restartable feature is not yet supported by PSA. Once it will in
3250 # the future, the following line could be removed (see issues
3251 # 6061, 6332 and following ones)
3252 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3253}
3254
Valerio Setti4e2f2442023-08-15 10:10:26 +02003255# Common helper used by:
3256# - component_test_psa_crypto_config_accel_ecc_no_bignum
3257# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003258#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003259# The goal is to build and test accelerating either:
3260# - ECC only or
3261# - both ECC and FFDH
3262#
3263# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003264# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3265# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003266common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003267 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003268
Valerio Setti5dfaca42023-09-05 08:48:51 +02003269 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003270 if [ "$test_target" = "ECC_DH" ]; then
3271 accel_text="ECC/FFDH"
3272 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003273 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003274 accel_text="ECC"
3275 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003276 fi
3277
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003278 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003279
3280 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003281 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3282 ALG_ECDH \
3283 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003284 $(helper_get_psa_key_type_list "ECC") \
3285 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003286 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003287 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003288 loc_accel_list="$loc_accel_list \
3289 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003290 $(helper_get_psa_key_type_list "DH") \
3291 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003292 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003293
3294 # Configure
3295 # ---------
3296
3297 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003298 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003299 # Disable all the builtin curves. All the required algs are accelerated.
3300 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003301
3302 # Build
3303 # -----
3304
3305 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003306 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3307 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3308 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003309
3310 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3311
Valerio Setti3fe105b2023-10-30 11:08:12 +01003312 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003313
3314 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3315 not grep mbedtls_ecdsa_ library/ecdsa.o
3316 not grep mbedtls_ecdh_ library/ecdh.o
3317 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003318 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003319 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003320 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003321 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003322 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003323
3324 # Run the tests
3325 # -------------
3326
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003327 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003328
Gilles Peskine21570cf2023-12-22 11:49:50 +01003329 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003330
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003331 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003332 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003333}
3334
Valerio Setti4e2f2442023-08-15 10:10:26 +02003335# Common helper used by:
3336# - component_test_psa_crypto_config_reference_ecc_no_bignum
3337# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3338#
3339# The goal is to build and test a reference scenario (i.e. with builtin
3340# components) compared to the ones used in
3341# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3342#
3343# It is meant to be used in conjunction with
3344# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3345# coverage analysis in "analyze_outcomes.py" script.
3346common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003347 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003348
Valerio Setti5dfaca42023-09-05 08:48:51 +02003349 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003350 if [ "$test_target" = "ECC_DH" ]; then
3351 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003352 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003353 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003354 fi
3355
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003356 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003357
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003358 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003359
Gilles Peskine21570cf2023-12-22 11:49:50 +01003360 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003361
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003362 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003363 make test
3364
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003365 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003366 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003367}
3368
Valerio Setti4e2f2442023-08-15 10:10:26 +02003369component_test_psa_crypto_config_accel_ecc_no_bignum () {
3370 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3371}
3372
3373component_test_psa_crypto_config_reference_ecc_no_bignum () {
3374 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3375}
3376
3377component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3378 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3379}
3380
3381component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3382 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3383}
3384
Valerio Settiac6d35f2023-08-04 12:49:11 +02003385# Helper for setting common configurations between:
3386# - component_test_tfm_config_p256m_driver_accel_ec()
3387# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003388common_tfm_config () {
3389 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003390 cp configs/config-tfm.h "$CONFIG_H"
3391 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3392 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003393
Yanray Wang73bb2312023-09-25 11:21:15 +08003394 # Other config adjustment to make the tests pass.
3395 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003396 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003397 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3398 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003399
Yanray Wang73bb2312023-09-25 11:21:15 +08003400 # Config adjustment for better test coverage in our environment.
3401 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003402 #
3403 # Enable filesystem I/O for the benefit of PK parse/write tests.
3404 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3405}
3406
Valerio Settiac6d35f2023-08-04 12:49:11 +02003407# Keep this in sync with component_test_tfm_config() as they are both meant
3408# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003409component_test_tfm_config_p256m_driver_accel_ec () {
3410 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3411
3412 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003413
Dave Rodgman897bb772023-11-15 16:34:20 +00003414 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003415 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003416
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003417 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3418 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003419 not grep mbedtls_ecdh_ library/ecdh.o
3420 not grep mbedtls_ecjpake_ library/ecjpake.o
3421 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3422 not grep mbedtls_ecp_ library/ecp.o
3423 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003424 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003425 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003426 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003427 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003428
Valerio Setti5e18b902023-12-04 12:07:30 +01003429 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3430 # files, so we want to ensure that it has not be re-enabled accidentally.
3431 not grep mbedtls_cipher library/cipher.o
3432
Valerio Settib7e95442023-03-21 11:52:33 +01003433 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003434 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003435 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003436}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003437
Valerio Settiac6d35f2023-08-04 12:49:11 +02003438# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3439# they are both meant to be used in analyze_outcomes.py for driver's coverage
3440# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003441component_test_tfm_config() {
3442 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003443
Dave Rodgman897bb772023-11-15 16:34:20 +00003444 # Disable P256M driver, which is on by default, so that analyze_outcomes
3445 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3446 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3447
Valerio Setti52ba0e32023-08-04 12:43:03 +02003448 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003449 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003450
Dave Rodgman897bb772023-11-15 16:34:20 +00003451 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003452 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003453
Valerio Setti5e18b902023-12-04 12:07:30 +01003454 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3455 # files, so we want to ensure that it has not be re-enabled accidentally.
3456 not grep mbedtls_cipher library/cipher.o
3457
Valerio Setti52ba0e32023-08-04 12:43:03 +02003458 msg "test: TF-M config"
3459 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003460}
3461
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003462# Common helper for component_full_without_ecdhe_ecdsa() and
3463# component_full_without_ecdhe_ecdsa_and_tls13() which:
3464# - starts from the "full" configuration minus the list of symbols passed in
3465# as 1st parameter
3466# - build
3467# - test only TLS (i.e. test_suite_tls and ssl-opt)
3468build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003469 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003470
3471 msg "build: full minus something, test TLS"
3472
3473 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003474 for sym in $symbols_to_disable; do
3475 echo "Disabling $sym"
3476 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003477 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003478
Gilles Peskine21570cf2023-12-22 11:49:50 +01003479 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003480
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003481 msg "test: full minus something, test TLS"
3482 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003483
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003484 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003485 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003486}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003487
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003488component_full_without_ecdhe_ecdsa () {
3489 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003490}
3491
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003492component_full_without_ecdhe_ecdsa_and_tls13 () {
3493 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3494 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003495}
3496
Valerio Setti249b18a2023-06-20 12:08:30 +02003497# This is an helper used by:
3498# - component_test_psa_ecc_key_pair_no_derive
3499# - component_test_psa_ecc_key_pair_no_generate
3500# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3501# enabled, but one. Input arguments are as follows:
3502# - $1 is the key type under test, i.e. ECC/RSA/DH
3503# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003504build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003505 key_type=$1
3506 unset_option=$2
3507 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003508
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003509 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003510 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003511 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3512 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3513
3514 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3515 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003516 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003517
Gilles Peskine21570cf2023-12-22 11:49:50 +01003518 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003519
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003520 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003521 make test
3522}
3523
3524component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003525 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003526}
3527
3528component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003529 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003530}
3531
Pengyu Lve705f572023-12-06 16:38:15 +08003532config_psa_crypto_accel_rsa () {
3533 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003534
Pengyu Lve705f572023-12-06 16:38:15 +08003535 # Start from crypto_full config (no X.509, no TLS)
3536 helper_libtestdriver1_adjust_config "crypto_full"
3537
3538 if [ "$driver_only" -eq 1 ]; then
3539 # Remove RSA support and its dependencies
3540 scripts/config.py unset MBEDTLS_RSA_C
3541 scripts/config.py unset MBEDTLS_PKCS1_V15
3542 scripts/config.py unset MBEDTLS_PKCS1_V21
3543
3544 # We need PEM parsing in the test library as well to support the import
3545 # of PEM encoded RSA keys.
3546 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3547 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3548 fi
3549}
3550
3551component_test_psa_crypto_config_accel_rsa_crypto () {
3552 msg "build: crypto_full with accelerated RSA"
3553
3554 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3555 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3556 KEY_TYPE_RSA_PUBLIC_KEY \
3557 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3558 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3559 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3560 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003561
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003562 # Configure
3563 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003564
Pengyu Lve705f572023-12-06 16:38:15 +08003565 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003566
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003567 # Build
3568 # -----
3569
Pengyu Lve705f572023-12-06 16:38:15 +08003570 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003571 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 +08003572 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003573 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003574
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003575 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003576
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003577 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003578 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003579
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003580 # Run the tests
3581 # -------------
3582
Pengyu Lve705f572023-12-06 16:38:15 +08003583 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003584 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003585}
3586
3587component_test_psa_crypto_config_reference_rsa_crypto () {
3588 msg "build: crypto_full with non-accelerated RSA"
3589
3590 # Configure
3591 # ---------
3592 config_psa_crypto_accel_rsa 0
3593
3594 # Build
3595 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003596 make
Pengyu Lve705f572023-12-06 16:38:15 +08003597
3598 # Run the tests
3599 # -------------
3600 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003601 make test
3602}
3603
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003604# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003605# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003606component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003607 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003608
Valerio Setti4590bc22023-06-13 15:39:23 +02003609 # Create a temporary output file unless there is already one set
3610 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3611 REMOVE_OUTCOME_ON_EXIT="no"
3612 else
3613 REMOVE_OUTCOME_ON_EXIT="yes"
3614 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3615 export MBEDTLS_TEST_OUTCOME_FILE
3616 fi
3617
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003618 # Start from crypto configuration
3619 scripts/config.py crypto
3620
3621 # Remove RSA support and its dependencies
3622 scripts/config.py unset MBEDTLS_PKCS1_V15
3623 scripts/config.py unset MBEDTLS_PKCS1_V21
3624 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3625 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3626 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3627 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3628 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3629 scripts/config.py unset MBEDTLS_RSA_C
3630 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3631
3632 # Enable PSA support
3633 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3634
Valerio Setti01cc88a2023-06-15 11:53:08 +02003635 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003636 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003637 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3638 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3639 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003640
3641 make
3642
Valerio Setti01cc88a2023-06-15 11:53:08 +02003643 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003644 make test
3645
3646 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3647 # performing RSA signature.
3648 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3649 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3650
3651 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3652 rm $MBEDTLS_TEST_OUTCOME_FILE
3653 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003654}
3655
Ronald Cronb2312452021-05-08 14:32:59 +02003656component_test_psa_crypto_config_accel_hash () {
3657 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3658
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003659 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3660 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3661 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003662
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003663 # Configure
3664 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003665
Ronald Cron46ac0652024-03-18 12:39:04 +01003666 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003667 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003668
3669 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003670 scripts/config.py unset MBEDTLS_MD5_C
3671 scripts/config.py unset MBEDTLS_RIPEMD160_C
3672 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003673 scripts/config.py unset MBEDTLS_SHA224_C
3674 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003675 scripts/config.py unset MBEDTLS_SHA384_C
3676 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003677 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003678
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003679 # Build
3680 # -----
3681
3682 helper_libtestdriver1_make_drivers "$loc_accel_list"
3683
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003684 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003685
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003686 # There's a risk of something getting re-enabled via config_psa.h;
3687 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3688 not grep mbedtls_md5 library/md5.o
3689 not grep mbedtls_sha1 library/sha1.o
3690 not grep mbedtls_sha256 library/sha256.o
3691 not grep mbedtls_sha512 library/sha512.o
3692 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003693
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003694 # Run the tests
3695 # -------------
3696
Ronald Cronb2312452021-05-08 14:32:59 +02003697 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3698 make test
3699}
3700
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003701component_test_psa_crypto_config_accel_hash_keep_builtins () {
3702 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3703 # This component ensures that all the test cases for
3704 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3705
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003706 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3707 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3708 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003709
Ronald Cron46ac0652024-03-18 12:39:04 +01003710 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003711 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003712
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003713 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003714
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003715 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003716
3717 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3718 make test
3719}
3720
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003721# Auxiliary function to build config for hashes with and without drivers
3722config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003723 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003724 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003725 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003726 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003727 # disable the built-in implementation of hashes
3728 scripts/config.py unset MBEDTLS_MD5_C
3729 scripts/config.py unset MBEDTLS_RIPEMD160_C
3730 scripts/config.py unset MBEDTLS_SHA1_C
3731 scripts/config.py unset MBEDTLS_SHA224_C
3732 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003733 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003734 scripts/config.py unset MBEDTLS_SHA384_C
3735 scripts/config.py unset MBEDTLS_SHA512_C
3736 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003737 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003738 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003739}
3740
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003741# Note that component_test_psa_crypto_config_reference_hash_use_psa
3742# is related to this component and both components need to be kept in sync.
3743# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003744component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003745 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003746
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003747 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3748 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3749 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003750
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003751 # Configure
3752 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003753
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003754 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003755
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003756 # Build
3757 # -----
3758
3759 helper_libtestdriver1_make_drivers "$loc_accel_list"
3760
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003761 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003762
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003763 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003764 # 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 +02003765 not grep mbedtls_md5 library/md5.o
3766 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003767 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003768 not grep mbedtls_sha512 library/sha512.o
3769 not grep mbedtls_ripemd160 library/ripemd160.o
3770
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003771 # Run the tests
3772 # -------------
3773
Gilles Peskine14302ed2023-07-19 19:30:04 +02003774 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003775 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003776
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003777 # This is mostly useful so that we can later compare outcome files with
3778 # the reference config in analyze_outcomes.py, to check that the
3779 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003780 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003781 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003782
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003783 # This is to make sure all ciphersuites are exercised, but we don't need
3784 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003785 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003786 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003787}
3788
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003789# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3790# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3791# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3792# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003793component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003794 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003795
3796 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003797
Gilles Peskine21570cf2023-12-22 11:49:50 +01003798 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003799
Gilles Peskine14302ed2023-07-19 19:30:04 +02003800 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003801 make test
3802
Gilles Peskine14302ed2023-07-19 19:30:04 +02003803 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003804 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003805}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003806
Valerio Setti8eb310c2024-01-22 16:22:57 +01003807# Auxiliary function to build config for hashes with and without drivers
3808config_psa_crypto_hmac_use_psa () {
3809 driver_only="$1"
3810 # start with config full for maximum coverage (also enables USE_PSA)
3811 helper_libtestdriver1_adjust_config "full"
3812
Valerio Setticd89b0b2024-01-24 14:24:55 +01003813 if [ "$driver_only" -eq 1 ]; then
3814 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3815 # is still enabled though (for ENTROPY_C among others).
3816 scripts/config.py unset MBEDTLS_MD_C
3817 # Disable also the builtin hashes since they are supported by the driver
3818 # and MD module is able to perform PSA dispathing.
3819 scripts/config.py unset-all MBEDTLS_SHA
3820 scripts/config.py unset MBEDTLS_MD5_C
3821 scripts/config.py unset MBEDTLS_RIPEMD160_C
3822 fi
3823
Valerio Setti8eb310c2024-01-22 16:22:57 +01003824 # Direct dependencies of MD_C. We disable them also in the reference
3825 # component to work with the same set of features.
3826 scripts/config.py unset MBEDTLS_PKCS7_C
3827 scripts/config.py unset MBEDTLS_PKCS5_C
3828 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3829 scripts/config.py unset MBEDTLS_HKDF_C
3830 # Dependencies of HMAC_DRBG
3831 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3832 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3833}
3834
3835component_test_psa_crypto_config_accel_hmac() {
3836 msg "test: full with accelerated hmac"
3837
3838 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3839 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3840 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3841 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3842
3843 # Configure
3844 # ---------
3845
3846 config_psa_crypto_hmac_use_psa 1
3847
Valerio Setti8eb310c2024-01-22 16:22:57 +01003848 # Build
3849 # -----
3850
3851 helper_libtestdriver1_make_drivers "$loc_accel_list"
3852
3853 helper_libtestdriver1_make_main "$loc_accel_list"
3854
3855 # Ensure that built-in support for HMAC is disabled.
3856 not grep mbedtls_md_hmac library/md.o
3857
3858 # Run the tests
3859 # -------------
3860
3861 msg "test: full with accelerated hmac"
3862 make test
3863}
3864
3865component_test_psa_crypto_config_reference_hmac() {
3866 msg "test: full without accelerated hmac"
3867
3868 config_psa_crypto_hmac_use_psa 0
3869
3870 make
3871
3872 msg "test: full without accelerated hmac"
3873 make test
3874}
3875
Valerio Setti9da01a72023-12-18 17:38:18 +01003876component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003877 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003878
Valerio Setti9da01a72023-12-18 17:38:18 +01003879 # Albeit this components aims at accelerating DES which should only support
3880 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3881 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003882 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3883 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3884 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003885
Valerio Setti9da01a72023-12-18 17:38:18 +01003886 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3887 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3888 # of this component. This limitation will be addressed by #8598.
3889
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003890 # Configure
3891 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003892
Valerio Setti9a427302023-10-17 11:40:42 +02003893 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003894 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003895
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003896 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003897 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3898 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3899 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3900 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3901 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3902 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3903 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003904 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003905
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003906 # Build
3907 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003908
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003909 helper_libtestdriver1_make_drivers "$loc_accel_list"
3910
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003911 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003912
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003913 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003914 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003915
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003916 # Run the tests
3917 # -------------
3918
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003919 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003920 make test
3921}
3922
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003923component_test_psa_crypto_config_accel_aead () {
3924 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3925
Valerio Setti3f02bb72023-10-02 15:57:33 +02003926 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3927 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003928
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003929 # Configure
3930 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003931
Valerio Setti3f02bb72023-10-02 15:57:33 +02003932 # Start from full config
3933 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003934
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003935 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003936 scripts/config.py unset MBEDTLS_GCM_C
3937 scripts/config.py unset MBEDTLS_CCM_C
3938 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003939
Valerio Settia50b89e2023-11-08 15:58:47 +01003940 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3941 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003942
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003943 # Build
3944 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003945
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003946 helper_libtestdriver1_make_drivers "$loc_accel_list"
3947
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003948 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003949
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003950 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003951 not grep mbedtls_ccm library/ccm.o
3952 not grep mbedtls_gcm library/gcm.o
3953 not grep mbedtls_chachapoly library/chachapoly.o
3954
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003955 # Run the tests
3956 # -------------
3957
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003958 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3959 make test
3960}
3961
Valerio Settib680fc42023-10-13 09:29:37 +02003962# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003963# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3964# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3965common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003966 # Start from the full config
3967 helper_libtestdriver1_adjust_config "full"
3968
Valerio Settib680fc42023-10-13 09:29:37 +02003969 scripts/config.py unset MBEDTLS_NIST_KW_C
3970}
3971
Valerio Settib6b301f2023-10-04 12:05:05 +02003972# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003973# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3974# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003975# are meant to be used together in analyze_outcomes.py script in order to test
3976# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003977component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3978 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003979
Valerio Settiad8b7f02023-10-25 12:39:50 +02003980 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 +01003981 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003982 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003983 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3984
3985 # Configure
3986 # ---------
3987
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003988 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003989
3990 # Disable the things that are being accelerated
3991 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3992 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3993 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3994 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3995 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3996 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3997 scripts/config.py unset MBEDTLS_GCM_C
3998 scripts/config.py unset MBEDTLS_CCM_C
3999 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004000 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004001 scripts/config.py unset MBEDTLS_DES_C
4002 scripts/config.py unset MBEDTLS_AES_C
4003 scripts/config.py unset MBEDTLS_ARIA_C
4004 scripts/config.py unset MBEDTLS_CHACHA20_C
4005 scripts/config.py unset MBEDTLS_CAMELLIA_C
4006
Valerio Settiec9b2582023-11-08 16:50:54 +01004007 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4008 # does not depend on it.
4009 scripts/config.py unset MBEDTLS_CIPHER_C
4010
Valerio Settib6b301f2023-10-04 12:05:05 +02004011 # Build
4012 # -----
4013
4014 helper_libtestdriver1_make_drivers "$loc_accel_list"
4015
4016 helper_libtestdriver1_make_main "$loc_accel_list"
4017
4018 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004019 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004020 not grep mbedtls_des library/des.o
4021 not grep mbedtls_aes library/aes.o
4022 not grep mbedtls_aria library/aria.o
4023 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004024 not grep mbedtls_ccm library/ccm.o
4025 not grep mbedtls_gcm library/gcm.o
4026 not grep mbedtls_chachapoly library/chachapoly.o
4027 not grep mbedtls_cmac library/cmac.o
4028
4029 # Run the tests
4030 # -------------
4031
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004032 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004033 make test
Valerio Settif9414552023-11-09 10:43:20 +01004034
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004035 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004036 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004037
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004038 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004039 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004040}
4041
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004042component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4043 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4044 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004045
Gilles Peskine21570cf2023-12-22 11:49:50 +01004046 make
Valerio Settif9414552023-11-09 10:43:20 +01004047
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004048 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004049 make test
Valerio Settif9414552023-11-09 10:43:20 +01004050
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004051 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004052 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004053
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004054 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004055 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004056}
4057
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004058common_block_cipher_dispatch() {
4059 TEST_WITH_DRIVER="$1"
4060
4061 # Start from the full config
4062 helper_libtestdriver1_adjust_config "full"
4063
4064 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4065 # Disable key types that are accelerated (there is no legacy equivalent
4066 # symbol for ECB)
4067 scripts/config.py unset MBEDTLS_AES_C
4068 scripts/config.py unset MBEDTLS_ARIA_C
4069 scripts/config.py unset MBEDTLS_CAMELLIA_C
4070 fi
4071
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004072 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004073 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004074 # Keep this also in the reference component in order to skip the same tests
4075 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004076 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4077 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4078 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4079 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4080 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4081 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4082 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004083
4084 # Disable direct dependency on AES_C
4085 scripts/config.py unset MBEDTLS_NIST_KW_C
4086
4087 # Prevent the cipher module from using deprecated PSA path. The reason is
4088 # that otherwise there will be tests relying on "aes_info" (defined in
4089 # "cipher_wrap.c") whose functions are not available when AES_C is
4090 # not defined. ARIA and Camellia are not a problem in this case because
4091 # the PSA path is not tested for these key types.
4092 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4093}
4094
Valerio Settif8e6cba2023-12-12 11:53:39 +01004095component_test_full_block_cipher_psa_dispatch () {
4096 msg "build: full + PSA dispatch in block_cipher"
4097
4098 loc_accel_list="ALG_ECB_NO_PADDING \
4099 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4100
4101 # Configure
4102 # ---------
4103
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004104 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004105
Valerio Settif8e6cba2023-12-12 11:53:39 +01004106 # Build
4107 # -----
4108
4109 helper_libtestdriver1_make_drivers "$loc_accel_list"
4110
4111 helper_libtestdriver1_make_main "$loc_accel_list"
4112
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004113 # Make sure disabled components were not re-enabled by accident (additive
4114 # config)
4115 not grep mbedtls_aes_ library/aes.o
4116 not grep mbedtls_aria_ library/aria.o
4117 not grep mbedtls_camellia_ library/camellia.o
4118
Valerio Settif8e6cba2023-12-12 11:53:39 +01004119 # Run the tests
4120 # -------------
4121
4122 msg "test: full + PSA dispatch in block_cipher"
4123 make test
4124}
4125
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004126# This is the reference component of component_test_full_block_cipher_psa_dispatch
4127component_test_full_block_cipher_legacy_dispatch () {
4128 msg "build: full + legacy dispatch in block_cipher"
4129
4130 common_block_cipher_dispatch 0
4131
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004132 make
4133
4134 msg "test: full + legacy dispatch in block_cipher"
4135 make test
4136}
4137
Gilles Peskine36dea152023-07-20 22:19:45 +02004138component_test_aead_chachapoly_disabled() {
4139 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004140 scripts/config.py full
4141 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004142 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004143 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004144
Gilles Peskine36dea152023-07-20 22:19:45 +02004145 msg "test: full minus CHACHAPOLY"
4146 make test
4147}
4148
4149component_test_aead_only_ccm() {
4150 msg "build: full minus CHACHAPOLY and GCM"
4151 scripts/config.py full
4152 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4153 scripts/config.py unset MBEDTLS_GCM_C
4154 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4155 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004156 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004157
4158 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004159 make test
4160}
4161
Ronald Crone501d0e2023-07-10 08:31:19 +02004162component_test_ccm_aes_sha256() {
4163 msg "build: CCM + AES + SHA256 configuration"
4164
Ronald Cron7612d8c2023-07-20 10:03:54 +02004165 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004166 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004167
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004168 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004169
4170 msg "test: CCM + AES + SHA256 configuration"
4171 make test
4172}
4173
John Durkopd0321952020-10-29 21:37:36 -07004174# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004175component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004176 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004177 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004178 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004179 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004180 scripts/config.py unset MBEDTLS_ECDH_C
4181 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4182 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4183 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4184 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4185 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4186 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004187 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 -07004188}
4189
4190# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004191component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004192 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004193 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004194 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004195 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004196 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004197 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004198}
4199
4200# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004201component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004202 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004203 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004204 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
4205 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004206 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4207 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004208 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004209 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004210}
4211
John Durkop1b7ee052020-11-27 08:51:22 -08004212# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4213component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004214 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004215 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004216 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004217 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004218 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4219 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4220 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4221 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4222 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4223 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4224 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004225 scripts/config.py unset MBEDTLS_LMS_C
4226 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004227 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004228 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 -08004229}
4230
4231# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4232component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004233 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004234 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004235 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004236 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004237 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4238 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4239 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4240 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4241 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4242 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4243 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004244 scripts/config.py unset MBEDTLS_LMS_C
4245 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004246 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004247 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 -08004248}
4249
4250# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4251component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004252 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004253 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004254 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004255 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004256 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4257 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4258 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4259 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4260 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4261 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4262 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004263 scripts/config.py unset MBEDTLS_LMS_C
4264 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004265 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004266 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 -08004267}
4268
4269# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4270component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004271 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004272 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004273 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004274 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004275 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4276 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4277 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4278 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4279 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4280 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004281 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004282 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 -08004283}
4284
4285# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4286component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004287 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004288 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004289 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004290 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004291 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4292 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4293 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4294 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4295 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4296 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004297 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004298 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 -08004299}
4300
4301# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4302component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004303 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004304 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004305 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004306 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004307 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4308 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4309 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4310 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4311 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4312 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004313 scripts/config.py unset MBEDTLS_LMS_C
4314 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004315 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004316 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 -08004317}
4318
4319# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4320component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004321 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004322 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004323 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004324 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004325 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4326 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4327 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4328 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4329 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4330 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4331 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004332 scripts/config.py unset MBEDTLS_LMS_C
4333 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004334 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004335 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 -08004336}
4337
John Durkopd0321952020-10-29 21:37:36 -07004338# 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 -08004339component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004340 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 -07004341 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004342 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004343 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004344 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4345 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4346 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4347 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004348 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004349 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 -07004350}
4351
4352# 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 -08004353component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004354 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 -07004355 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004356 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004357 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004358 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4359 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4360 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4361 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004362 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004363 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 -07004364}
4365
4366# 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 -08004367component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004368 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 -07004369 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004370 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004371 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004372 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4373 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4374 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4375 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004376 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004377 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 -07004378}
4379
4380# 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 -08004381component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004382 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 -07004383 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004384 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004385 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004386 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4387 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4388 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4389 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004390 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004391 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 -07004392}
4393
4394# 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 -08004395component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004396 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 -07004397 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004398 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004399 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004400 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4401 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4402 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4403 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4404 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004405 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004406 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 -07004407}
4408
4409# 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 -08004410component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004411 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 -07004412 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004413 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004414 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004415 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4416 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004417 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004418 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 -07004419}
4420
Dave Rodgmanc164c072023-06-28 09:43:23 +01004421
Dave Rodgman904c5892023-06-28 17:36:02 +01004422support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004423 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004424}
4425
Dave Rodgman904c5892023-06-28 17:36:02 +01004426component_build_tfm_armcc() {
4427 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004428 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004429
Dave Rodgman88651c42023-06-29 12:35:51 +01004430 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004431 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 +01004432}
4433
4434component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004435 # Check that the TF-M configuration can build cleanly with various
4436 # warning flags enabled. We don't build or run tests, since the
4437 # TF-M configuration needs a TF-M platform. A tweaked version of
4438 # the configuration that works on mainstream platforms is in
4439 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004440 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004441
Dave Rodgman88651c42023-06-29 12:35:51 +01004442 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004443 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 +01004444
Dave Rodgman904c5892023-06-28 17:36:02 +01004445 msg "build: TF-M config, gcc native build"
4446 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004447 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 +01004448}
4449
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004450# Test that the given .o file builds with all (valid) combinations of the given options.
4451#
4452# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4453#
4454# The validator function is the name of a function to validate the combination of options.
4455# It may be "" if all combinations are valid.
4456# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004457# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004458build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004459 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004460 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004461 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004462 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004463 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004464
Dave Rodgman42436102023-10-03 15:47:05 +01004465 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004466 for opt in "${options[@]}"; do
4467 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004468 done
4469
4470 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004471 cd $(dirname ${file})
4472 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004473
Dave Rodgman920343a2023-10-01 18:41:09 +01004474 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004475 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 +01004476
Dave Rodgman42436102023-10-03 15:47:05 +01004477 # Extract the command generated by the Makefile to build the target file.
4478 # This ensures that we have any include paths, macro definitions, etc
4479 # that may be applied by make.
4480 # 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 +01004481 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004482
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004483 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004484 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004485
Dave Rodgman28e38d82023-10-04 11:50:30 +01004486 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004487 source_file=${file%.o}.c
4488
4489 targets=0
4490 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004491
Dave Rodgman28e38d82023-10-04 11:50:30 +01004492 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004493 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004494 # each bit of $i is used to determine if options[i] will be set or not
4495 target="t"
4496 clang_args=""
4497 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004498 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004499 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004500 clang_args="${clang_args} ${opt}"
4501 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004502 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004503 done
4504
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004505 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004506 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004507 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004508 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004509
Dave Rodgman28e38d82023-10-04 11:50:30 +01004510 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004511 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004512 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004513 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004514
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004515 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004516
Dave Rodgman920343a2023-10-01 18:41:09 +01004517 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004518 make -s -f ${makefile} build_test_config_combos
4519 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004520
4521 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004522 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004523}
4524
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004525validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004526 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4527 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004528 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004529 fi
4530 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4531 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004532 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004533 fi
4534 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004535 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004536}
4537
4538component_build_aes_variations() {
4539 # 18s - around 90ms per clang invocation on M1 Pro
4540 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004541 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004542 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004543
Yanray Wangbc29aef2023-11-06 11:08:17 +08004544 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004545 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004546
Dave Rodgman42436102023-10-03 15:47:05 +01004547 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004548 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4549 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4550 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4551 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004552
4553 cd "$MBEDTLS_ROOT_DIR"
4554 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4555
Yanray Wang42be1ba2023-11-23 14:28:47 +08004556 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004557 # manually set or unset those configurations to check
4558 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004559 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4560 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4561 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4562 scripts/config.py unset MBEDTLS_DES_C
4563 scripts/config.py unset MBEDTLS_NIST_KW_C
4564 build_test_config_combos library/aes.o validate_aes_config_variations \
4565 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4566 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4567 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4568 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004569}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004570
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004571component_test_no_platform () {
4572 # Full configuration build, without platform support, file IO and net sockets.
4573 # This should catch missing mbedtls_printf definitions, and by disabling file
4574 # IO, it should catch missing '#include <stdio.h>'
4575 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004576 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004577 scripts/config.py unset MBEDTLS_PLATFORM_C
4578 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004579 scripts/config.py unset MBEDTLS_FS_IO
4580 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004581 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004582 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004583 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004584 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004585 # to re-enable platform integration features otherwise disabled in C99 builds
4586 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004587 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004588}
Gilles Peskine7c652162017-12-11 00:01:40 +01004589
4590component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004591 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004592 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4593 scripts/config.py full
4594 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004595 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4596 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4597 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4598 make
4599}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004600
Gilles Peskine8f073122018-11-27 15:58:47 +01004601component_build_no_ssl_srv () {
4602 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004603 scripts/config.py full
4604 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004605 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004606}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004607
Gilles Peskine8f073122018-11-27 15:58:47 +01004608component_build_no_ssl_cli () {
4609 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004610 scripts/config.py full
4611 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004612 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004613}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004614
Gilles Peskine8f073122018-11-27 15:58:47 +01004615component_build_no_sockets () {
4616 # Note, C99 compliance can also be tested with the sockets support disabled,
4617 # as that requires a POSIX platform (which isn't the same as C99).
4618 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004619 scripts/config.py full
4620 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4621 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4622 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4623}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004624
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004625component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004626 msg "build: default config with memory buffer allocator and backtrace enabled"
4627 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4628 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4629 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004630 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004631 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004632 make
4633
4634 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4635 make test
4636}
4637
4638component_test_memory_buffer_allocator () {
4639 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004640 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4641 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004642 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004643 make
4644
4645 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4646 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004647
4648 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4649 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004650 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004651}
4652
Gilles Peskine8f073122018-11-27 15:58:47 +01004653component_test_no_max_fragment_length () {
4654 # Run max fragment length tests with MFL disabled
4655 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004656 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004657 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004658 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004659
Gilles Peskine8f073122018-11-27 15:58:47 +01004660 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004661 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004662}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004663
Hanno Becker545ced42019-02-19 11:10:48 +00004664component_test_asan_remove_peer_certificate () {
4665 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004666 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004667 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004668 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004669 make
4670
4671 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4672 make test
4673
4674 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004675 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004676
4677 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004678 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004679
4680 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004681 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004682}
4683
Gilles Peskine8f073122018-11-27 15:58:47 +01004684component_test_no_max_fragment_length_small_ssl_out_content_len () {
4685 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004686 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4687 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4688 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004689 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004690 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004691
Gilles Peskine8f073122018-11-27 15:58:47 +01004692 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004693 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004694
4695 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004696 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004697}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004698
Darryl Greenaad82f92019-12-02 10:53:11 +00004699component_test_variable_ssl_in_out_buffer_len () {
4700 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4701 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004702 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004703 make
4704
4705 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4706 make test
4707
4708 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004709 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004710
4711 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004712 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004713}
4714
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004715component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004716 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004717 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004718
Dave Rodgman17127e92023-12-14 16:42:48 +00004719 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004720 make
4721
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004722 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004723 make test
4724
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004725 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004726 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004727
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004728 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004729 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004730}
4731
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004732component_test_ssl_alloc_buffer_and_mfl () {
4733 msg "build: default config with memory buffer allocator and MFL extension"
4734 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4735 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4736 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4737 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4738 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004739 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004740 make
4741
4742 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4743 make test
4744
4745 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 +02004746 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004747}
4748
Gilles Peskine636c26a2020-03-04 20:46:15 +01004749component_test_when_no_ciphersuites_have_mac () {
4750 msg "build: when no ciphersuites have MAC"
4751 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004752 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004753 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004754 make
4755
4756 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4757 make test
4758
4759 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004760 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004761}
4762
Raoul Strackxa4e86142020-06-15 17:03:13 +02004763component_test_no_date_time () {
4764 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4765 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004766 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004767 make
4768
4769 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4770 make test
4771}
4772
Gilles Peskine8f073122018-11-27 15:58:47 +01004773component_test_platform_calloc_macro () {
4774 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004775 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4776 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4777 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004778 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004779 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004780
Gilles Peskine8f073122018-11-27 15:58:47 +01004781 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4782 make test
4783}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004784
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004785component_test_malloc_0_null () {
4786 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004787 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004788 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 +02004789
4790 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4791 make test
4792
4793 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4794 # Just the calloc selftest. "make test" ran the others as part of the
4795 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004796 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004797
4798 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4799 # Run a subset of the tests. The choice is a balance between coverage
4800 # and time (including time indirectly wasted due to flaky tests).
4801 # The current choice is to skip tests whose description includes
4802 # "proxy", which is an approximation of skipping tests that use the
4803 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004804 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004805}
4806
Dave Rodgman6a08b682023-06-19 11:51:33 +01004807support_test_aesni() {
4808 # Check that gcc targets x86_64 (we can build AESNI), and check for
4809 # AESNI support on the host (we can run AESNI).
4810 #
4811 # The name of this function is possibly slightly misleading, but needs to align
4812 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004813 #
4814 # In principle 32-bit x86 can support AESNI, but our implementation does not
4815 # support 32-bit x86, so we check for x86-64.
4816 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004817 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4818 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004819 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004820}
4821
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004822component_test_aesni () { # ~ 60s
4823 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4824 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4825 #
4826 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4827 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4828 # exercise the plain C impl).
4829
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004830 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004831 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004832 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004833 scripts/config.py set MBEDTLS_HAVE_ASM
4834
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004835 # test the intrinsics implementation
4836 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004837 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004838 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004839 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004840 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004841
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004842 # test the asm implementation
4843 msg "AES tests, test assembly"
4844 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004845 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004846 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004847 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004848
4849 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004850 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004851 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004852 msg "AES tests, plain C"
4853 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004854 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004855 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004856 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004857 not grep -q "AES note: using AESNI" ./programs/test/selftest
4858 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004859
4860 # test the intrinsics implementation
4861 scripts/config.py set MBEDTLS_AESNI_C
4862 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4863 msg "AES tests, test AESNI only"
4864 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004865 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004866 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4867 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004868 grep -q "AES note: using AESNI" ./programs/test/selftest
4869 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004870}
4871
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004872component_test_sha3_variations() {
4873 msg "sha3 loop unroll variations"
4874
4875 # define minimal config sufficient to test SHA3
4876 cat > include/mbedtls/mbedtls_config.h << END
4877 #define MBEDTLS_SELF_TEST
4878 #define MBEDTLS_SHA3_C
4879END
4880
4881 msg "all loops unrolled"
4882 make clean
4883 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=1 -DMBEDTLS_SHA3_PI_UNROLL=1 -DMBEDTLS_SHA3_CHI_UNROLL=1 -DMBEDTLS_SHA3_RHO_UNROLL=1"
4884 ./tests/test_suite_shax
4885
4886 msg "all loops rolled up"
4887 make clean
4888 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=0 -DMBEDTLS_SHA3_PI_UNROLL=0 -DMBEDTLS_SHA3_CHI_UNROLL=0 -DMBEDTLS_SHA3_RHO_UNROLL=0"
4889 ./tests/test_suite_shax
4890}
4891
Jerry Yub6d39c22023-08-16 15:11:48 +08004892support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004893 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004894}
4895
4896component_test_aesni_m32 () { # ~ 60s
4897 # This tests are duplicated from component_test_aesni for i386 target
4898 #
4899 # AESNI intrinsic code supports i386 and assembly code does not support it.
4900
4901 msg "build: default config with different AES implementations"
4902 scripts/config.py set MBEDTLS_AESNI_C
4903 scripts/config.py set MBEDTLS_PADLOCK_C
4904 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4905 scripts/config.py set MBEDTLS_HAVE_ASM
4906
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004907 # test the intrinsics implementation with gcc
4908 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004909 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004910 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004911 # check that we built intrinsics - this should be used by default when supported by the compiler
4912 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4913 grep -q "AES note: using AESNI" ./programs/test/selftest
4914 grep -q "AES note: built-in implementation." ./programs/test/selftest
4915 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4916 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4917
4918 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004919 scripts/config.py unset MBEDTLS_PADLOCK_C
4920 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4921 msg "AES tests, test AESNI only"
4922 make clean
4923 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4924 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4925 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4926 grep -q "AES note: using AESNI" ./programs/test/selftest
4927 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4928 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4929 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4930}
4931
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004932support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004933 # clang >= 4 is required to build with target attributes
4934 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004935}
4936
4937component_test_aesni_m32_clang() {
4938
4939 scripts/config.py set MBEDTLS_AESNI_C
4940 scripts/config.py set MBEDTLS_PADLOCK_C
4941 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4942 scripts/config.py set MBEDTLS_HAVE_ASM
4943
4944 # test the intrinsics implementation with clang
4945 msg "AES tests, test intrinsics (clang)"
4946 make clean
4947 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4948 # check that we built intrinsics - this should be used by default when supported by the compiler
4949 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4950 grep -q "AES note: using AESNI" ./programs/test/selftest
4951 grep -q "AES note: built-in implementation." ./programs/test/selftest
4952 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4953 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4954}
4955
Jerry Yu193cbc02023-08-03 17:06:29 +08004956# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4957component_build_aes_aesce_armcc () {
4958 msg "Build: AESCE test on arm64 platform without plain C."
4959 scripts/config.py baremetal
4960
4961 # armc[56] don't support SHA-512 intrinsics
4962 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4963
4964 # Stop armclang warning about feature detection for A64_CRYPTO.
4965 # With this enabled, the library does build correctly under armclang,
4966 # but in baremetal builds (as tested here), feature detection is
4967 # unavailable, and the user is notified via a #warning. So enabling
4968 # this feature would prevent us from building with -Werror on
4969 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004970 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004971 scripts/config.py set MBEDTLS_HAVE_ASM
4972
4973 msg "AESCE, build with default configuration."
4974 scripts/config.py set MBEDTLS_AESCE_C
4975 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4976 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4977
4978 msg "AESCE, build AESCE only"
4979 scripts/config.py set MBEDTLS_AESCE_C
4980 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4981 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4982}
4983
Dave Rodgman0c584032023-10-08 12:26:54 +01004984support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004985 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004986 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004987}
4988
4989component_build_aes_armce () {
4990 # Test variations of AES with Armv8 crypto extensions
4991 scripts/config.py set MBEDTLS_AESCE_C
4992 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4993
4994 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004995 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004996
4997 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4998 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4999
5000 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5001 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5002
Dave Rodgman5e419372023-10-23 15:30:20 +01005003 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01005004
Dave Rodgman5e419372023-10-23 15:30:20 +01005005 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
5006 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005007
Dave Rodgman5e419372023-10-23 15:30:20 +01005008 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5009 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01005010
Dave Rodgman5e419372023-10-23 15:30:20 +01005011 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5012 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01005013
5014 # test for presence of AES instructions
5015 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5016 msg "clang, test A32 crypto instructions built"
5017 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5018 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5019 msg "clang, test T32 crypto instructions built"
5020 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5021 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5022 msg "clang, test aarch64 crypto instructions built"
5023 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5024 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
5025
5026 # test for absence of AES instructions
5027 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
5028 scripts/config.py unset MBEDTLS_AESCE_C
5029 msg "clang, test A32 crypto instructions not built"
5030 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5031 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5032 msg "clang, test T32 crypto instructions not built"
5033 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5034 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5035 msg "clang, test aarch64 crypto instructions not built"
5036 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5037 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01005038}
5039
Dave Rodgman9ed18532023-10-05 00:06:47 +01005040support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00005041 # clang >= 4 is required to build with SHA extensions
5042 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01005043}
5044
Dave Rodgmand9e80832023-10-04 17:17:46 +01005045component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01005046 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005047
5048
5049 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01005050 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005051 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
5052 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5053 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
5054 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5055 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005056
Dave Rodgmand9e80832023-10-04 17:17:46 +01005057
Dave Rodgman94a634d2023-10-10 12:59:29 +01005058 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005059 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005060 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
5061 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5062 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005063
Dave Rodgman5b89c552023-10-10 14:59:02 +01005064 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005065 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
5066 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5067 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01005068
Dave Rodgmancd654002023-10-05 09:40:07 +01005069
Dave Rodgman94a634d2023-10-10 12:59:29 +01005070 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005071 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005072 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
5073 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
5074 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
5075 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5076 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005077
Dave Rodgmancd654002023-10-05 09:40:07 +01005078
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005079 # examine the disassembly for presence of SHA instructions
5080 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5081 scripts/config.py set ${opt}
5082 msg "${opt} clang, test A32 crypto instructions built"
5083 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5084 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5085
5086 msg "${opt} clang, test T32 crypto instructions built"
5087 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5088 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5089
5090 msg "${opt} clang, test aarch64 crypto instructions built"
5091 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5092 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5093 scripts/config.py unset ${opt}
5094 done
5095
5096
5097 # examine the disassembly for absence of SHA instructions
5098 msg "clang, test A32 crypto instructions not built"
5099 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5100 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5101
5102 msg "clang, test T32 crypto instructions not built"
5103 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5104 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5105
5106 msg "clang, test aarch64 crypto instructions not built"
5107 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5108 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005109}
5110
Jerry Yuc935aa62023-08-03 17:08:27 +08005111# For timebeing, no VIA Padlock platform available.
5112component_build_aes_via_padlock () {
5113
5114 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005115 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005116 scripts/config.py set MBEDTLS_PADLOCK_C
5117 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005118 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005119 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005120
5121}
5122
5123support_build_aes_via_padlock_only () {
5124 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5125 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5126 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5127}
5128
Jerry Yu193cbc02023-08-03 17:06:29 +08005129support_build_aes_aesce_armcc () {
5130 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005131}
5132
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005133component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005134 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005135 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005136 scripts/config.py unset MBEDTLS_PADLOCK_C
5137
Dave Rodgmand8d64512023-12-19 12:20:21 +00005138 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005139
5140 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5141 make test
5142}
5143
5144component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5145 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5146 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005147 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5148 scripts/config.py unset MBEDTLS_PADLOCK_C
5149
Hanno Becker83ebf782017-07-07 12:29:15 +01005150 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005151
5152 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005153 make test
5154}
Gilles Peskine8f073122018-11-27 15:58:47 +01005155
Hanno Becker83ebf782017-07-07 12:29:15 +01005156component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005157 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5158 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5159 scripts/config.py unset MBEDTLS_PADLOCK_C
5160 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005161 scripts/config.py unset MBEDTLS_AESCE_C
5162
Dave Rodgmand8d64512023-12-19 12:20:21 +00005163 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005164
5165 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005166 make test
5167
5168 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5169 programs/test/selftest
5170}
5171
Matthias Schulz0767fda2024-02-07 10:46:28 +01005172component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005173 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5174 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005175 scripts/config.py unset MBEDTLS_PADLOCK_C
5176 scripts/config.py unset MBEDTLS_AESNI_C
5177 scripts/config.py unset MBEDTLS_AESCE_C
5178
5179 make CFLAGS='-O2 -Werror -Wall -Wextra'
5180
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005181 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005182 make test
5183}
5184
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005185component_test_aes_fewer_tables () {
5186 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005187 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005188 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005189
Gilles Peskine7c652162017-12-11 00:01:40 +01005190 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005191 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005192}
5193
5194component_test_aes_rom_tables () {
5195 msg "build: default config with AES_ROM_TABLES enabled"
5196 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005197 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005198
5199 msg "test: AES_ROM_TABLES"
5200 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005201}
5202
Gilles Peskine14c3c062018-01-29 21:25:12 +01005203component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005204 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5205 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5206 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005207 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005208
Gilles Peskine8f073122018-11-27 15:58:47 +01005209 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5210 make test
5211}
5212
Yanray Wang49cd4b52023-11-10 11:58:37 +08005213# helper for common_block_cipher_no_decrypt() which:
5214# - enable/disable the list of config options passed from -s/-u respectively.
5215# - build
5216# - test for tests_suite_xxx
5217# - selftest
5218#
5219# Usage: helper_block_cipher_no_decrypt_build_test
5220# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5221# Options: -s set_opts the list of config options to enable
5222# -u unset_opts the list of config options to disable
5223# -c cflags the list of options passed to CFLAGS
5224# -l ldflags the list of options passed to LDFLAGS
5225helper_block_cipher_no_decrypt_build_test () {
5226 while [ $# -gt 0 ]; do
5227 case "$1" in
5228 -s)
5229 shift; local set_opts="$1";;
5230 -u)
5231 shift; local unset_opts="$1";;
5232 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005233 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005234 -l)
5235 shift; local ldflags="$1";;
5236 esac
5237 shift
5238 done
5239 set_opts="${set_opts:-}"
5240 unset_opts="${unset_opts:-}"
5241 cflags="${cflags:-}"
5242 ldflags="${ldflags:-}"
5243
Yanray Wangb2d6e522023-11-13 16:57:47 +08005244 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5245 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005246
5247 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5248 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005249 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005250
5251 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5252 not grep mbedtls_aes_setkey_dec library/aes.o
5253 not grep mbedtls_aria_setkey_dec library/aria.o
5254 not grep mbedtls_camellia_setkey_dec library/camellia.o
5255 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5256 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005257 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5258 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005259
5260 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5261 make test
5262
5263 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5264 programs/test/selftest
5265}
5266
5267# This is a common configuration function used in:
5268# - component_test_block_cipher_no_decrypt_aesni_legacy()
5269# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5270# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5271# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5272# on x86.
5273common_block_cipher_no_decrypt () {
5274 # test AESNI intrinsics
5275 helper_block_cipher_no_decrypt_build_test \
5276 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005277 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005278
5279 # test AESNI assembly
5280 helper_block_cipher_no_decrypt_build_test \
5281 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005282 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005283
5284 # test AES C implementation
5285 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005286 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005287
5288 # test AESNI intrinsics for i386 target
5289 helper_block_cipher_no_decrypt_build_test \
5290 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005291 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005292 -l "-m32"
5293}
5294
Yanray Wang3ae11992023-11-13 17:32:09 +08005295# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5296# usage: 0: no PSA crypto configuration
5297# 1: use PSA crypto configuration
5298config_block_cipher_no_decrypt () {
5299 use_psa=$1
5300
Yanray Wang66111392023-10-31 18:54:54 +08005301 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005302 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5303 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005304 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005305 scripts/config.py unset MBEDTLS_NIST_KW_C
5306
Yanray Wang3ae11992023-11-13 17:32:09 +08005307 if [ "$use_psa" -eq 1 ]; then
5308 # Enable support for cryptographic mechanisms through the PSA API.
5309 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5310 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5311 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5312 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5313 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5314 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5315 fi
5316}
5317
5318component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005319 # This consistently causes an llvm crash on clang 3.8, so use gcc
5320 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005321 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005322 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005323}
5324
Yanray Wangf1496402023-11-01 18:55:13 +08005325component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005326 # This consistently causes an llvm crash on clang 3.8, so use gcc
5327 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005328 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005329 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005330}
5331
Yanray Wang66111392023-10-31 18:54:54 +08005332support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005333 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005334}
5335
Yanray Wang66111392023-10-31 18:54:54 +08005336component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005337 scripts/config.py baremetal
5338
5339 # armc[56] don't support SHA-512 intrinsics
5340 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5341
5342 # Stop armclang warning about feature detection for A64_CRYPTO.
5343 # With this enabled, the library does build correctly under armclang,
5344 # but in baremetal builds (as tested here), feature detection is
5345 # unavailable, and the user is notified via a #warning. So enabling
5346 # this feature would prevent us from building with -Werror on
5347 # armclang. Tracked in #7198.
5348 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5349 scripts/config.py set MBEDTLS_HAVE_ASM
5350
Yanray Wang3ae11992023-11-13 17:32:09 +08005351 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005352
5353 # test AESCE baremetal build
5354 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005355 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005356 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005357
Yanray Wangef1b04d2023-09-08 11:09:26 +08005358 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5359 not grep mbedtls_aes_setkey_dec library/aes.o
5360 not grep mbedtls_aria_setkey_dec library/aria.o
5361 not grep mbedtls_camellia_setkey_dec library/camellia.o
5362 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5363 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005364 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005365 not grep mbedtls_aesce_inverse_key library/aesce.o
5366 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005367}
5368
Gilles Peskine592f5912019-10-07 18:49:32 +02005369component_test_ctr_drbg_aes_256_sha_256 () {
5370 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5371 scripts/config.py full
5372 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5373 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005374 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005375 make
5376
5377 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5378 make test
5379}
5380
5381component_test_ctr_drbg_aes_128_sha_512 () {
5382 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005383 scripts/config.py full
5384 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5385 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005386 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005387 make
5388
5389 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5390 make test
5391}
5392
5393component_test_ctr_drbg_aes_128_sha_256 () {
5394 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005395 scripts/config.py full
5396 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5397 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5398 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005399 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005400 make
5401
5402 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5403 make test
5404}
5405
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005406component_test_se_default () {
5407 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005408 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005409 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005410
5411 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5412 make test
5413}
5414
Steven Cooremand57203d2020-07-16 20:28:59 +02005415component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005416 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005417 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005418 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005419 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5420 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005421 loc_cflags="${loc_cflags} -I../tests/include -O2"
5422
Gilles Peskine21570cf2023-12-22 11:49:50 +01005423 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005424
Gilles Peskine1997f302023-07-26 18:45:20 +02005425 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005426 make test
5427}
5428
Gilles Peskine8f073122018-11-27 15:58:47 +01005429component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005430 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005431 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005432 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005433 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005434}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005435
Gilles Peskinecf740502019-07-03 20:43:05 +02005436component_test_cmake_shared () {
5437 msg "build/test: cmake shared" # ~ 2min
5438 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5439 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005440 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005441 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005442 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005443}
5444
Gilles Peskineec10bf12019-09-20 19:56:06 +02005445test_build_opt () {
5446 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005447 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005448 for opt in "$@"; do
5449 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005450 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005451 # We're confident enough in compilers to not run _all_ the tests,
5452 # but at least run the unit tests. In particular, runs with
5453 # optimizations use inline assembly whereas runs with -O0
5454 # skip inline assembly.
5455 make test # ~30s
5456 make clean
5457 done
5458}
5459
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005460# For FreeBSD we invoke the function by name so this condition is added
5461# to disable the existing test_clang_opt function for linux.
5462if [[ $(uname) != "Linux" ]]; then
5463 component_test_clang_opt () {
5464 scripts/config.py full
5465 test_build_opt 'full config' clang -O0 -Os -O2
5466 }
5467fi
5468
5469component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005470 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005471 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005472}
5473support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005474 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005475}
5476
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005477component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005478 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005479 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005480}
5481support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005482 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005483}
5484
5485component_test_gcc_latest_opt () {
5486 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005487 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005488}
5489support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005490 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005491}
5492
5493component_test_gcc_earliest_opt () {
5494 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005495 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005496}
5497support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005498 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005499}
5500
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005501component_build_mbedtls_config_file () {
5502 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005503 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005504 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005505 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005506 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005507 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5508 make clean
5509
5510 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5511 # In the user config, disable one feature (for simplicity, pick a feature
5512 # that nothing else depends on).
5513 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005514 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005515 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5516
5517 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005518}
5519
Gilles Peskine7d904e72022-04-07 21:59:14 +02005520component_build_psa_config_file () {
5521 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5522 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5523 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5524 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5525 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005526 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005527 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5528 make clean
5529
5530 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5531 # In the user config, disable one feature, which will reflect on the
5532 # mbedtls configuration so we can query it with query_compile_time_config.
5533 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5534 scripts/config.py unset MBEDTLS_CMAC_C
5535 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5536 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5537
5538 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005539}
5540
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005541component_build_psa_alt_headers () {
5542 msg "build: make with PSA alt headers" # ~20s
5543
5544 # Generate alternative versions of the substitutable headers with the
5545 # same content except different include guards.
5546 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5547
5548 # Build the library and some programs.
5549 # Don't build the fuzzers to avoid having to go through hoops to set
5550 # a correct include path for programs/fuzz/Makefile.
5551 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
5552 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\"'"
5553
5554 # Check that we're getting the alternative include guards and not the
5555 # original include guards.
5556 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5557 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5558 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5559 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5560}
5561
Dave Rodgman852de3c2023-12-14 14:46:45 +00005562component_test_m32_no_asm () {
5563 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005564 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005565 #
5566 # Note that we require gcc, because clang Asan builds fail to link for
5567 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005568 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005569 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005570 scripts/config.py unset MBEDTLS_HAVE_ASM
5571 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005572 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005573 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005574
Dave Rodgman852de3c2023-12-14 14:46:45 +00005575 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005576 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005577}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005578support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005579 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005580 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005581 *) false;;
5582 esac
5583}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005584
Gilles Peskineff0aee02021-10-05 09:36:03 +02005585component_test_m32_o2 () {
5586 # Build with optimization, to use the i386 specific inline assembly
5587 # and go faster for tests.
5588 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005589 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005590 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005591 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005592
Gilles Peskineff0aee02021-10-05 09:36:03 +02005593 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005594 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005595
Gilles Peskineff0aee02021-10-05 09:36:03 +02005596 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005597 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005598}
Gilles Peskinecf522222021-10-07 19:25:29 +02005599support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005600 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005601}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005602
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005603component_test_m32_everest () {
5604 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005605 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005606 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005607 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005608
5609 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5610 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005611
5612 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005613 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005614
5615 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5616 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005617 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005618}
5619support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005620 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005621}
5622
Gilles Peskine8f073122018-11-27 15:58:47 +01005623component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005624 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005625 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005626 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005627
5628 msg "test: 64-bit ILP32, make, gcc"
5629 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005630}
Gilles Peskine878cf602019-01-06 20:50:38 +00005631support_test_mx32 () {
5632 case $(uname -m) in
5633 amd64|x86_64) true;;
5634 *) false;;
5635 esac
5636}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005637
Peter Kolbus60c6da22018-12-27 06:59:04 -06005638component_test_min_mpi_window_size () {
5639 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005640 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005641 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005642 make
5643
5644 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5645 make test
5646}
5647
Gilles Peskine8f073122018-11-27 15:58:47 +01005648component_test_have_int32 () {
5649 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005650 scripts/config.py unset MBEDTLS_HAVE_ASM
5651 scripts/config.py unset MBEDTLS_AESNI_C
5652 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005653 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005654 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005655
Gilles Peskine8f073122018-11-27 15:58:47 +01005656 msg "test: gcc, force 32-bit bignum limbs"
5657 make test
5658}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005659
Gilles Peskine8f073122018-11-27 15:58:47 +01005660component_test_have_int64 () {
5661 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005662 scripts/config.py unset MBEDTLS_HAVE_ASM
5663 scripts/config.py unset MBEDTLS_AESNI_C
5664 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005665 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005666 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005667
Gilles Peskine8f073122018-11-27 15:58:47 +01005668 msg "test: gcc, force 64-bit bignum limbs"
5669 make test
5670}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005671
Gabor Mezeie256cc12023-07-26 17:28:48 +02005672component_test_have_int32_cmake_new_bignum () {
5673 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5674 scripts/config.py unset MBEDTLS_HAVE_ASM
5675 scripts/config.py unset MBEDTLS_AESNI_C
5676 scripts/config.py unset MBEDTLS_PADLOCK_C
5677 scripts/config.py unset MBEDTLS_AESCE_C
5678 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005679 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005680 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005681
5682 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5683 make test
5684}
5685
Gilles Peskine8f073122018-11-27 15:58:47 +01005686component_test_no_udbl_division () {
5687 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005688 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005689 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005690 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005691
Gilles Peskine8f073122018-11-27 15:58:47 +01005692 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5693 make test
5694}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005695
Gilles Peskine8f073122018-11-27 15:58:47 +01005696component_test_no_64bit_multiplication () {
5697 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005698 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005699 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005700 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005701
Gilles Peskine8f073122018-11-27 15:58:47 +01005702 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5703 make test
5704}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005705
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005706component_test_no_strings () {
5707 msg "build: no strings" # ~10s
5708 scripts/config.py full
5709 # Disable options that activate a large amount of string constants.
5710 scripts/config.py unset MBEDTLS_DEBUG_C
5711 scripts/config.py unset MBEDTLS_ERROR_C
5712 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5713 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005714 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005715
5716 msg "test: no strings" # ~ 10s
5717 make test
5718}
5719
Hanno Beckerc5722d12020-10-09 11:10:42 +01005720component_test_no_x509_info () {
5721 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5722 scripts/config.pl full
5723 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5724 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005725 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005726
5727 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5728 make test
5729
5730 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005731 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005732}
5733
Gilles Peskine8f073122018-11-27 15:58:47 +01005734component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005735 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005736 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005737 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 +02005738
Gilles Peskinee36fe812021-09-01 20:00:33 +02005739 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005740 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005741}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005742
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005743component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005744 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005745 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005746 # Build for a target platform that's close to what Debian uses
5747 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005748 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005749 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005750 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005751 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'
5752
Gilles Peskinee36fe812021-09-01 20:00:33 +02005753 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005754 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005755}
5756support_build_arm_linux_gnueabi_gcc_arm5vte () {
5757 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5758}
5759
5760component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005761 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005762 scripts/config.py baremetal
5763 # This is an imperfect substitute for
5764 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005765 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005766 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 +02005767
Gilles Peskinee36fe812021-09-01 20:00:33 +02005768 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005769 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005770}
5771
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005772component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005773 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5774 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005775 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 +02005776
Gilles Peskinee36fe812021-09-01 20:00:33 +02005777 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005778 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005779 for lib in library/*.a; do
5780 echo "$lib:"
5781 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5782 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005783}
5784
Gilles Peskine8f073122018-11-27 15:58:47 +01005785component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005786 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005787 scripts/config.py baremetal
5788 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005789 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 +01005790 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005791 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005792}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005793
Gilles Peskine8f073122018-11-27 15:58:47 +01005794component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005795 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005796 scripts/config.py baremetal
5797 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005798 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 +01005799 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005800 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005801}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005802
Dave Rodgman8c315f22023-06-02 10:26:24 -04005803component_build_arm_clang_thumb () {
5804 # ~ 30s
5805
5806 scripts/config.py baremetal
5807
5808 msg "build: clang thumb 2, make"
5809 make clean
5810 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5811
5812 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5813 msg "build: clang thumb 1 -O0, make"
5814 make clean
5815 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5816
5817 msg "build: clang thumb 1 -Os, make"
5818 make clean
5819 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5820}
5821
Gilles Peskine8f073122018-11-27 15:58:47 +01005822component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005823 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005824 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005825 # armc[56] don't support SHA-512 intrinsics
5826 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005827
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005828 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5829 scripts/config.py unset MBEDTLS_AESCE_C
5830
Dave Rodgman0fddf822023-03-02 15:32:12 +00005831 # Stop armclang warning about feature detection for A64_CRYPTO.
5832 # With this enabled, the library does build correctly under armclang,
5833 # but in baremetal builds (as tested here), feature detection is
5834 # unavailable, and the user is notified via a #warning. So enabling
5835 # this feature would prevent us from building with -Werror on
5836 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005837 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005838
Hanno Beckerf0762e92022-07-15 12:08:19 +01005839 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005840
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005841 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005842
5843 msg "size: ARM Compiler 5"
5844 "$ARMC5_FROMELF" -z library/*.o
5845
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005846 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005847
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005848 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005849 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005850
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005851 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005852 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5853
5854 # ARM Compiler 6 - Target ARMv7-M+DSP
5855 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005856
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005857 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005858 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005859
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005860 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005861 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005862
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005863 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5864 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5865
Dave Rodgman99318e62023-05-24 12:27:42 +01005866 # ARM Compiler 6 - Target Cortex-M0
5867 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005868
5869 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5870 #
5871 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5872 # that we have in our CI
5873 scripts/config.py set MBEDTLS_AESCE_C
5874 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005875}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005876
Pengyu Lvdf070032023-02-24 16:03:31 +08005877support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005878 armc5_cc="$ARMC5_BIN_DIR/armcc"
5879 armc6_cc="$ARMC6_BIN_DIR/armclang"
5880 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005881}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005882
Ronald Crond2cb7f42024-03-18 12:49:18 +01005883component_test_tls12_only () {
5884 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5885 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5886 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5887 make
5888
5889 msg "test: main suites (inc. selftests) (ASan build)"
5890 make test
5891
5892 msg "test: ssl-opt.sh (ASan build)"
5893 tests/ssl-opt.sh
5894
5895 msg "test: compat.sh (ASan build)"
5896 tests/compat.sh
5897}
5898
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005899component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005900 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005901 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005902 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005903 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5904
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005905 msg "test: TLS 1.3 only, all key exchange modes enabled"
5906 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005907
Ronald Cronc3f43b62022-10-17 17:35:32 +02005908 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5909 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005910}
5911
Ronald Cronc3f43b62022-10-17 17:35:32 +02005912component_test_tls13_only_psk () {
5913 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5914 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5915 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5916 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005917 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005918 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5919 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5920 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5921 scripts/config.py unset MBEDTLS_ECDSA_C
5922 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005923 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005924 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005925 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5926
Ronald Cronc3f43b62022-10-17 17:35:32 +02005927 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5928 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005929
Ronald Cronc3f43b62022-10-17 17:35:32 +02005930 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5931 tests/ssl-opt.sh
5932}
5933
5934component_test_tls13_only_ephemeral () {
5935 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5936 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5937 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005938 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005939 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5940
5941 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5942 cd tests; ./test_suite_ssl; cd ..
5943
5944 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5945 tests/ssl-opt.sh
5946}
5947
Przemek Stekiela01c2422023-06-13 10:46:48 +02005948component_test_tls13_only_ephemeral_ffdh () {
5949 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5950 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5951 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5952 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005953 scripts/config.py unset MBEDTLS_ECDH_C
5954
Przemek Stekiela01c2422023-06-13 10:46:48 +02005955 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5956
5957 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5958 cd tests; ./test_suite_ssl; cd ..
5959
5960 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5961 tests/ssl-opt.sh
5962}
5963
Ronald Cronc3f43b62022-10-17 17:35:32 +02005964component_test_tls13_only_psk_ephemeral () {
5965 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5966 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5967 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5968 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5969 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5970 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5971 scripts/config.py unset MBEDTLS_ECDSA_C
5972 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005973 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005974 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005975 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5976
5977 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5978 cd tests; ./test_suite_ssl; cd ..
5979
5980 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5981 tests/ssl-opt.sh
5982}
5983
Przemek Stekiela01c2422023-06-13 10:46:48 +02005984component_test_tls13_only_psk_ephemeral_ffdh () {
5985 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5986 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5987 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5988 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5989 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5990 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5991 scripts/config.py unset MBEDTLS_ECDSA_C
5992 scripts/config.py unset MBEDTLS_PKCS1_V21
5993 scripts/config.py unset MBEDTLS_PKCS7_C
5994 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005995 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005996 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5997
5998 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5999 cd tests; ./test_suite_ssl; cd ..
6000
6001 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6002 tests/ssl-opt.sh
6003}
6004
Ronald Cronc3f43b62022-10-17 17:35:32 +02006005component_test_tls13_only_psk_all () {
6006 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
6007 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6008 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6009 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6010 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6011 scripts/config.py unset MBEDTLS_ECDSA_C
6012 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00006013 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01006014 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006015 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6016
6017 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6018 cd tests; ./test_suite_ssl; cd ..
6019
6020 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6021 tests/ssl-opt.sh
6022}
6023
6024component_test_tls13_only_ephemeral_all () {
6025 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
6026 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01006027 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006028 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6029
6030 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6031 cd tests; ./test_suite_ssl; cd ..
6032
6033 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6034 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02006035}
6036
Ronald Cron46ac0652024-03-18 12:39:04 +01006037component_test_tls13_no_padding () {
6038 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006039 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01006040 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006041 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006042 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006043 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006044 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01006045 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006046 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006047}
6048
Ronald Cron6f135e12021-12-08 16:57:54 +01006049component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01006050 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006051 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01006052 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006053 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01006054 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006055 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006056 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01006057 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006058 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006059}
6060
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006061component_test_full_minus_session_tickets() {
6062 msg "build: full config without session tickets"
6063 scripts/config.py full
Norbert Fabritius06d99342023-04-11 15:40:05 +02006064 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006065 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritius06d99342023-04-11 15:40:05 +02006066 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
6067 make
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006068 msg "test: full config without session tickets"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006069 make test
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006070 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006071 tests/ssl-opt.sh
6072}
6073
Gilles Peskine8f073122018-11-27 15:58:47 +01006074component_build_mingw () {
6075 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006076 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 +00006077
Gilles Peskine8f073122018-11-27 15:58:47 +01006078 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006079 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 +01006080 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02006081
Gilles Peskine8f073122018-11-27 15:58:47 +01006082 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006083 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
6084 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 +01006085 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006086
Pengyu Lv158eead2023-10-19 11:27:05 +08006087 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006088 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08006089 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 +01006090 make WINDOWS_BUILD=1 clean
6091}
Jaeden Amero117b8a42019-04-17 15:19:26 +01006092support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08006093 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
6094 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01006095 *) true;;
6096 esac
6097}
Simon Butcher91aef332016-11-17 09:20:50 +00006098
Gilles Peskine8f073122018-11-27 15:58:47 +01006099component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006100 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02006101 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006102 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6103 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006104
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006105 msg "test: main suites (MSan)" # ~ 10s
6106 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006107
Gilles Peskine6848d172023-11-02 19:58:03 +01006108 msg "test: metatests (MSan)"
6109 tests/scripts/run-metatests.sh any msan
6110
Gilles Peskine82b27272019-06-14 18:27:03 +02006111 msg "program demos (MSan)" # ~20s
6112 tests/scripts/run_demos.py
6113
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006114 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006115 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006116
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006117 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006118
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006119 if [ "$MEMORY" -gt 0 ]; then
6120 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006121 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006122 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006123}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006124
Bence Szépkúti0354d042023-12-06 16:14:37 +01006125component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006126 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006127 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006128 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6129 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006130
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006131 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006132 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006133
Gilles Peskine636c26a2020-03-04 20:46:15 +01006134 # Optional parts (slow; currently broken on OS X because programs don't
6135 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006136 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006137 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006138 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006139 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006140 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006141
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006142 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006143 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006144 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006145 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006146
6147 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006148 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006149 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006150 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006151}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006152
Bence Szépkúti0354d042023-12-06 16:14:37 +01006153component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006154 msg "build: Release, full (clang)"
6155 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6156 scripts/config.py full
6157 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6158 make
6159
6160 msg "test: main suites, Valgrind (full config)"
6161 make memcheck
6162}
6163
Paul Elliott62dc3922021-11-25 17:29:40 +00006164support_test_cmake_out_of_source () {
6165 distrib_id=""
6166 distrib_ver=""
6167 distrib_ver_minor=""
6168 distrib_ver_major=""
6169
6170 # Attempt to parse lsb-release to find out distribution and version. If not
6171 # found this should fail safe (test is supported).
6172 if [[ -f /etc/lsb-release ]]; then
6173
6174 while read -r lsb_line; do
6175 case "$lsb_line" in
6176 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6177 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6178 esac
6179 done < /etc/lsb-release
6180
6181 distrib_ver_major="${distrib_ver%%.*}"
6182 distrib_ver="${distrib_ver#*.}"
6183 distrib_ver_minor="${distrib_ver%%.*}"
6184 fi
6185
6186 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6187 # processor (as the CI does) can create a race condition whereby the build
6188 # fails to see a generated file, despite that file actually having been
6189 # generated. This problem appears to go away with 18.04 or newer, so make
6190 # the out of source tests unsupported on Ubuntu 16.04.
6191 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6192}
6193
Gilles Peskine8f073122018-11-27 15:58:47 +01006194component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006195 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006196 # generates
6197 make neat
6198
Gilles Peskine8f073122018-11-27 15:58:47 +01006199 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006200 MBEDTLS_ROOT_DIR="$PWD"
6201 mkdir "$OUT_OF_SOURCE_DIR"
6202 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006203 # Note: Explicitly generate files as these are turned off in releases
6204 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006205 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006206
Gilles Peskine8f073122018-11-27 15:58:47 +01006207 msg "test: cmake 'out-of-source' build"
6208 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006209 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006210 # Also ensure that there are no error messages such as
6211 # "No such file or directory", which would indicate that some required
6212 # file is missing (ssl-opt.sh tolerates the absence of some files so
6213 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006214 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006215 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006216 cat ssl-opt.err >&2
6217 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006218 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006219 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006220 cd "$MBEDTLS_ROOT_DIR"
6221 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006222}
Andres AGdc192212016-08-31 17:33:13 +01006223
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006224component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006225 # Remove existing generated files so that we use the ones CMake
6226 # generates
6227 make neat
6228
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006229 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006230 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006231 # Note: Explicitly generate files as these are turned off in releases
6232 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006233 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006234 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006235}
Gilles Peskinea3000992022-02-04 00:21:12 +01006236support_test_cmake_as_subdirectory () {
6237 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006238}
6239
Chris Kayd259e342021-03-25 16:03:25 +00006240component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006241 # Remove existing generated files so that we use the ones CMake
6242 # generates
6243 make neat
6244
Chris Kayd259e342021-03-25 16:03:25 +00006245 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006246 cd programs/test/cmake_package
6247 cmake .
6248 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006249 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006250}
Gilles Peskinea3000992022-02-04 00:21:12 +01006251support_test_cmake_as_package () {
6252 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006253}
6254
6255component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006256 # Remove existing generated files so that we use the ones CMake
6257 # generates
6258 make neat
6259
Chris Kayd259e342021-03-25 16:03:25 +00006260 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006261 cd programs/test/cmake_package_install
6262 cmake .
6263 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006264 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006265}
Gilles Peskinea3000992022-02-04 00:21:12 +01006266support_test_cmake_as_package_install () {
6267 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006268}
6269
David Horstmann20550e32023-01-12 14:17:01 +00006270component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006271 # Make a copy of config file to use for the in-tree test
6272 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006273
6274 MBEDTLS_ROOT_DIR="$PWD"
6275 mkdir "$OUT_OF_SOURCE_DIR"
6276 cd "$OUT_OF_SOURCE_DIR"
6277
David Horstmann969c1452023-01-31 10:34:44 +00006278 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006279 cmake "$MBEDTLS_ROOT_DIR"
6280 make
6281
6282 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6283 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006284 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006285 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6286 make
6287
6288 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6289 # In the user config, disable one feature (for simplicity, pick a feature
6290 # that nothing else depends on).
6291 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6292
6293 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6294 make
6295 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6296
6297 rm -f user_config.h full_config.h
6298
6299 cd "$MBEDTLS_ROOT_DIR"
6300 rm -rf "$OUT_OF_SOURCE_DIR"
6301
6302 # Now repeat the test for an in-tree build:
6303
David Horstmann969c1452023-01-31 10:34:44 +00006304 # Restore config for the in-tree test
6305 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006306
David Horstmann969c1452023-01-31 10:34:44 +00006307 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006308 cmake .
6309 make
6310
6311 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6312 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006313 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006314 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6315 make
6316
6317 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6318 # In the user config, disable one feature (for simplicity, pick a feature
6319 # that nothing else depends on).
6320 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6321
6322 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6323 make
6324 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6325
6326 rm -f user_config.h full_config.h
6327}
6328support_build_cmake_custom_config_file () {
6329 support_test_cmake_out_of_source
6330}
6331
6332
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006333component_build_zeroize_checks () {
6334 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6335
6336 scripts/config.py full
6337
6338 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006339 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-zeroize-memset.h\"' -DMBEDTLS_TEST_DEFINES_ZEROIZE -Werror -Wsizeof-pointer-memaccess"
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006340}
6341
6342
Gilles Peskine8f073122018-11-27 15:58:47 +01006343component_test_zeroize () {
6344 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6345 # different combinations of compilers and optimization flags by using an
6346 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6347 # system in all cases that the script fails, so we must manually search the
6348 # output to check whether the pass string is present and no failure strings
6349 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006350
Gilles Peskine4976e822019-01-06 19:52:22 +00006351 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6352 # about a spurious message if Gdb tries and fails, so suppress that.
6353 gdb_disable_aslr=
6354 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6355 gdb_disable_aslr='set disable-randomization off'
6356 fi
6357
Gilles Peskine8f073122018-11-27 15:58:47 +01006358 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006359 for compiler in clang gcc; do
6360 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6361 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006362 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6363 grep "The buffer was correctly zeroized" test_zeroize.log
6364 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006365 rm -f test_zeroize.log
6366 make clean
6367 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006368 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006369}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006370
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006371component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006372 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006373 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006374 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006375
6376 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006377 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006378}
6379
6380support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006381 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006382 ver="$(cmake --version)"
6383 ver="${ver#cmake version }"
6384 ver_major="${ver%%.*}"
6385
6386 ver="${ver#*.}"
6387 ver_minor="${ver%%.*}"
6388
6389 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006390}
6391
Gilles Peskinec848d222022-12-09 12:23:35 +01006392component_check_code_style () {
6393 msg "Check C code style"
6394 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006395}
6396
Gilles Peskinec848d222022-12-09 12:23:35 +01006397support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006398 case $(uncrustify --version) in
6399 *0.75.1*) true;;
6400 *) false;;
6401 esac
6402}
6403
Gilles Peskine8f073122018-11-27 15:58:47 +01006404component_check_python_files () {
6405 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006406 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006407}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006408
Joe Subbianid614c0b2021-07-29 11:18:29 +01006409component_check_test_helpers () {
6410 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006411 # unittest writes out mundane stuff like number or tests run on stderr.
6412 # Our convention is to reserve stderr for actual errors, and write
6413 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006414 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006415
Joe Subbiania25ffab2021-08-06 09:41:27 +01006416 msg "unit test: translate_ciphers.py"
6417 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006418}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006419
Jerry Yud767cc42023-03-31 15:03:55 +08006420
Gilles Peskine192c72f2017-12-21 15:59:21 +01006421################################################################
6422#### Termination
6423################################################################
6424
Gilles Peskine8f073122018-11-27 15:58:47 +01006425post_report () {
6426 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006427 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006428
Gilles Peskine8f073122018-11-27 15:58:47 +01006429 final_report
6430}
6431
6432
6433
6434################################################################
6435#### Run all the things
6436################################################################
6437
Gilles Peskine5d996822020-03-28 21:09:21 +01006438# Function invoked by --error-test to test error reporting.
6439pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006440 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006441 if [ $KEEP_GOING -ne 0 ]; then
6442 echo "Expect three failing commands."
6443 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006444 # If the component doesn't run in a subshell, changing error_test_i to an
6445 # invalid integer will cause an error in the loop that runs this function.
6446 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006447 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006448 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006449 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006450 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006451 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006452 make unknown_target
6453 false "this should not be executed"
6454}
6455
Gilles Peskinee48351a2018-11-27 16:06:30 +01006456# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006457run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006458 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006459 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006460
6461 # Unconditionally create a seedfile that's sufficiently long.
6462 # Do this before each component, because a previous component may
6463 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006464 local dd_cmd
6465 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6466 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006467 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006468 esac
6469 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006470
Gilles Peskineec135542021-08-02 23:14:03 +02006471 # Run the component in a subshell, with error trapping and output
6472 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006473 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006474 # We want to keep running if the subshell fails, so 'set -e' must
6475 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006476 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006477 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006478 (
6479 if [ $QUIET -eq 1 ]; then
6480 # msg() will be silenced, so just print the component name here.
6481 echo "${current_component#component_}"
6482 exec >/dev/null
6483 fi
6484 if [ $KEEP_GOING -eq 1 ]; then
6485 # Keep "set -e" off, and run an ERR trap instead to record failures.
6486 set -E
6487 trap err_trap ERR
6488 fi
6489 # The next line is what runs the component
6490 "$@"
6491 if [ $KEEP_GOING -eq 1 ]; then
6492 trap - ERR
6493 exit $last_failure_status
6494 fi
6495 )
6496 component_status=$?
6497 if [ $KEEP_GOING -eq 1 ]; then
6498 set -e
6499 if [ $component_status -ne 0 ]; then
6500 failure_count=$((failure_count + 1))
6501 fi
6502 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006503
6504 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006505 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006506 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006507}
6508
6509# Preliminary setup
6510pre_check_environment
6511pre_initialize_variables
6512pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006513
Dave Rodgman21900632024-02-26 11:41:19 +00006514setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006515pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006516pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006517pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006518
Gilles Peskine878cf602019-01-06 20:50:38 +00006519build_status=0
6520if [ $KEEP_GOING -eq 1 ]; then
6521 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006522fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006523pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006524pre_print_configuration
6525pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006526cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006527if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006528 pre_generate_files
6529fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006530
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006531# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006532for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006533 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006534done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006535unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006536for component in $RUN_COMPONENTS; do
6537 run_component "component_$component"
6538done
Gilles Peskine8f073122018-11-27 15:58:47 +01006539
6540# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006541post_report