blob: 0ef5babc24011ac38f8f67685883c09601ceefce [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
Ronald Cron7e5d61c2024-06-10 14:25:46 +0200136 CRYPTO_CONFIG_H='tf-psa-crypto/include/psa/crypto_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100137 else
138 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
Ronald Cron7e5d61c2024-06-10 14:25:46 +0200139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100140 fi
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100141 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200142
143 # Files that are clobbered by some jobs will be backed up. Use a different
144 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
145 # independently decide when to remove the backup file.
146 backup_suffix='.all.bak'
147 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100148 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100149 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100150 # Files clobbered by in-tree cmake
151 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
152 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200153
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200154 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100155 MEMORY=0
156 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200157 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100158 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100159
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200160 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200161 #
162 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
163 # both values are kept in sync. If you change the value here because it
164 # breaks some tests, you'll definitely want to change it in
165 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200166 RELEASE_SEED=1
167
Yanray Wang18040ed2023-11-23 21:29:56 +0800168 # Specify character collation for regular expressions and sorting with C locale
169 export LC_COLLATE=C
170
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200171 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200172 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200173 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200174 export MBEDTLS_TEST_PLATFORM
175
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000176 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100178 : ${OPENSSL_NEXT:="$OPENSSL"}
179 : ${GNUTLS_CLI:="gnutls-cli"}
180 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100181 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
182 : ${ARMC5_BIN_DIR:=/usr/bin}
183 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200184 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200185 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100186 : ${CLANG_LATEST:="clang-latest"}
187 : ${CLANG_EARLIEST:="clang-earliest"}
188 : ${GCC_LATEST:="gcc-latest"}
189 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100190 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000191 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200192 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100193 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000194 # if CC is not set, use clang by default (if present) to improve build times
195 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000196 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000197 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000198
Ronald Cronc5e81d22024-04-02 14:39:53 +0200199 if [ -n "${OPENSSL_3+set}" ]; then
200 export OPENSSL_NEXT="$OPENSSL_3"
201 fi
202
Gilles Peskine396853a2021-09-20 18:57:55 +0200203 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000204 export CTEST_OUTPUT_ON_FAILURE=1
205
Gilles Peskine8fd59422019-10-21 17:11:33 +0200206 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100207 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200208 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000209 # Normally, tests should use this compiler for ASAN testing
210 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200211
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400212 # Platform tests have an allocation that returns null
213 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400214 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400215
Gilles Peskine878cf602019-01-06 20:50:38 +0000216 # Gather the list of available components. These are the functions
217 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100218 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000219
Valerio Setti9022f712024-06-27 07:59:39 +0200220 PSASIM_PATH='tests/psa-client-server/psasim/'
221
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000222 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100223 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100224}
Andres AG38495a32016-07-12 16:54:33 +0100225
Dave Rodgman21900632024-02-26 11:41:19 +0000226setup_quiet_wrappers()
227{
228 # Pick up "quiet" wrappers for make and cmake, which don't output very much
229 # unless there is an error. This reduces logging overhead in the CI.
230 #
231 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000232 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
233 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000234 fi
235}
236
Gilles Peskinea28db922019-01-10 00:05:18 +0100237# Test whether the component $1 is included in the command line patterns.
238is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239{
Gilles Peskine03af6782021-08-06 11:35:17 +0200240 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
241 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100242 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000243 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100244 set +f
245 case ${1#component_} in $pattern) return 0;; esac
246 done
247 set +f
248 return 1
249}
Andres AG7770ea82016-10-10 15:46:20 +0100250
Simon Butcher41eeccf2016-09-07 00:07:09 +0100251usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100252{
Gilles Peskine709346a2017-12-10 23:43:39 +0100253 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100254Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100255Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100256By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100257COMPONENT can be the name of a component or a shell wildcard pattern.
258
259Examples:
260 $0 "check_*"
261 Run all sanity checks.
262 $0 --no-armcc --except test_memsan
263 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100264
265Special options:
266 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000267 --list-all-components List all available test components and exit.
268 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269
270General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200271 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100272 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100273 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100274 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200275 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200276 --arm-none-eabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-none-eabi
278 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200279 --arm-linux-gnueabi-gcc-prefix=<string>
280 Prefix for a cross-compiler for arm-linux-gnueabi
281 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100282 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200283 --restore First clean up the build tree, restoring backed up
284 files. Do not run any components unless they are
285 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100286 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200287 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100288 --except Exclude the COMPONENTs listed on the command line,
289 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200290 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100291 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100292 --no-force Refuse to overwrite modified files (default).
293 --no-keep-going Stop at the first error (default).
294 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800295 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100296 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200297 --outcome-file=<path> File where test outcomes are written (not done if
298 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100299 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200300 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100301 -s|--seed Integer seed value to use for this test run.
302
303Tool path options:
304 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
305 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100306 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
307 --clang-latest=<Clang_latest_path> Latest version of clang available
308 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
309 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100310 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
311 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100312 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100313 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100314EOF
SimonB2e23c822016-04-16 21:54:39 +0100315}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100316
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200317# Cleanup before/after running a component.
318# Remove built files as well as the cmake cache/config.
319# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100320cleanup()
321{
David Horstmann76a77382023-08-17 17:32:26 +0100322 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100323 command make clean
324 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200325
Gilles Peskine31b07e22018-03-21 12:15:06 +0100326 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000327 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100328 -iname CMakeFiles -exec rm -rf {} \+ -o \
329 \( -iname cmake_install.cmake -o \
330 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200331 -iname CMakeCache.txt -o \
332 -path './cmake/*.cmake' \) -exec rm -f {} \+
Ronald Cron5cdc22b2024-06-12 10:04:22 +0200333 # Remove Makefiles generated by in-tree CMake builds
334 rm -f 3rdparty/Makefile 3rdparty/*/Makefile pkgconfig/Makefile framework/Makefile
335 rm -f include/Makefile programs/!(fuzz)/Makefile
Ronald Cron30ea2b92024-06-11 14:07:09 +0200336 rm -f tf-psa-crypto/Makefile tf-psa-crypto/include/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200337
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100338 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
339 rm -rf programs/test/cmake_subproject/build
340 rm -f programs/test/cmake_subproject/Makefile
341 rm -f programs/test/cmake_subproject/cmake_subproject
342
Chris Kayd259e342021-03-25 16:03:25 +0000343 # Remove any artifacts from the component_test_cmake_as_package test.
344 rm -rf programs/test/cmake_package/build
345 rm -f programs/test/cmake_package/Makefile
346 rm -f programs/test/cmake_package/cmake_package
347
348 # Remove any artifacts from the component_test_cmake_as_installed_package test.
349 rm -rf programs/test/cmake_package_install/build
350 rm -f programs/test/cmake_package_install/Makefile
351 rm -f programs/test/cmake_package_install/cmake_package_install
352
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 # Restore files that may have been clobbered by the job
354 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200355 if [[ -e "$x$backup_suffix" ]]; then
356 cp -p "$x$backup_suffix" "$x"
357 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358 done
359}
John Durkopbd069d32020-10-31 22:14:03 -0700360
Valerio Setti9022f712024-06-27 07:59:39 +0200361# This is a helper function to be used in psasim builds. It is meant to clean
362# up the library's workspace after the server build and before the client
363# build. Built libraries (mbedcrypto, mbedx509 and mbedtls) are supposed to be
364# already copied to psasim folder at this point.
Valerio Settid8b59372024-07-02 12:02:25 +0200365helper_psasim_cleanup_before_client() {
Valerio Setti9022f712024-06-27 07:59:39 +0200366 # Clean up library files
367 make -C library clean
368 # Clean up intermediate files that were used to build the server
369 make -C $PSASIM_PATH clean_server_intermediate_files
370 # Restore files that were backup before building library files. This
371 # includes $CONFIG_H and $CRYPTO_CONFIG_H.
372 for x in $files_to_back_up; do
373 if [[ -e "$x$backup_suffix" ]]; then
374 cp -p "$x$backup_suffix" "$x"
375 fi
376 done
377}
378
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200379# Final cleanup when this script exits (except when exiting on a failure
380# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200381final_cleanup () {
382 cleanup
383
384 for x in $files_to_back_up; do
385 rm -f "$x$backup_suffix"
386 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100387}
388
Gilles Peskine7c652162017-12-11 00:01:40 +0100389# Executed on exit. May be redefined depending on command line options.
390final_report () {
391 :
392}
393
394fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200395 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100396 final_report $1
397 trap - $1
398 kill -$1 $$
399}
400
401trap 'fatal_signal HUP' HUP
402trap 'fatal_signal INT' INT
403trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200404
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200405# Number of processors on this machine. Used as the default setting
406# for parallel make.
407all_sh_nproc ()
408{
409 {
410 nproc || # Linux
411 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
412 sysctl -n hw.ncpu || # FreeBSD
413 echo 1
414 } 2>/dev/null
415}
416
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100417msg()
418{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100419 if [ -n "${current_component:-}" ]; then
420 current_section="${current_component#component_}: $1"
421 else
422 current_section="$1"
423 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200424
425 if [ $QUIET -eq 1 ]; then
426 return
427 fi
428
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100429 echo ""
430 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100431 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000432 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100433 echo "******************************************************************"
434}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100435
Gilles Peskine8f073122018-11-27 15:58:47 +0100436armc6_build_test()
437{
438 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100439
Gilles Peskine18487f62020-04-30 23:11:54 +0200440 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800441 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100442 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000443 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200444
445 msg "size: ARM Compiler 6 ($FLAGS)"
446 "$ARMC6_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +0200447 "$ARMC6_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +0200448 "$ARMC6_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100449}
Andres AGa5cd9732016-10-17 15:23:10 +0100450
Andres AGd9eba4b2016-08-26 14:42:14 +0100451err_msg()
452{
453 echo "$1" >&2
454}
455
456check_tools()
457{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200458 for tool in "$@"; do
459 if ! `type "$tool" >/dev/null 2>&1`; then
460 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100461 exit 1
462 fi
463 done
464}
465
Gilles Peskine8f073122018-11-27 15:58:47 +0100466pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000467 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100468 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100469 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100470 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200471 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000472 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100473
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000474 # Note that legacy options are ignored instead of being omitted from this
475 # list of options, so invocations that worked with previous version of
476 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100477 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200479 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200480 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200481 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000482 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100483 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
484 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100485 --clang-earliest) shift; CLANG_EARLIEST="$1";;
486 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100487 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000488 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100489 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100490 --gcc-earliest) shift; GCC_EARLIEST="$1";;
491 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100492 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200493 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
494 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100495 --gnutls-serv) shift; GNUTLS_SERV="$1";;
496 --help|-h) usage; exit;;
497 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000498 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100499 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100500 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200501 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000502 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100503 --no-force) FORCE=0;;
504 --no-keep-going) KEEP_GOING=0;;
505 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200506 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100507 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100508 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200509 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100510 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200511 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100512 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200513 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200514 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100515 --seed|-s) shift; SEED="$1";;
516 -*)
517 echo >&2 "Unknown option: $1"
518 echo >&2 "Run $0 --help for usage."
519 exit 120
520 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000521 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100522 esac
523 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100524 done
SimonB2e23c822016-04-16 21:54:39 +0100525
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100526 # Exclude components that are not supported on this platform.
527 SUPPORTED_COMPONENTS=
528 for component in $ALL_COMPONENTS; do
529 case $(type "support_$component" 2>&1) in
530 *' function'*)
531 if ! support_$component; then continue; fi;;
532 esac
533 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
534 done
535
536 if [ $list_components -eq 1 ]; then
537 printf '%s\n' $SUPPORTED_COMPONENTS
538 exit
539 fi
540
Gilles Peskinea28db922019-01-10 00:05:18 +0100541 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200542 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000543 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100544 fi
545
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000546 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
547 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100548 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000549 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100550 fi
SimonB2e23c822016-04-16 21:54:39 +0100551
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200552 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100553 if [ $all_except -eq 0 ]; then
554 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200555 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
556 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200557 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100558 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200559 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200560 # If the requested name includes a wildcard character, don't
561 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100562 case $component in
563 *[*?\[]*) continue;;
564 esac
565 case " $SUPPORTED_COMPONENTS " in
566 *" $component "*) :;;
567 *)
568 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
569 unsupported=$((unsupported + 1));;
570 esac
571 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200572 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100573 if [ $unsupported -ne 0 ]; then
574 exit 2
575 fi
576 fi
577
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000578 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100579 RUN_COMPONENTS=
580 for component in $SUPPORTED_COMPONENTS; do
581 if is_component_included "$component"; [ $? -eq $all_except ]; then
582 RUN_COMPONENTS="$RUN_COMPONENTS $component"
583 fi
584 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000585
586 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000587 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100588}
SimonB2e23c822016-04-16 21:54:39 +0100589
Gilles Peskine8f073122018-11-27 15:58:47 +0100590pre_check_git () {
591 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100592 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100593 git checkout-index -f -q $CONFIG_H
594 cleanup
595 else
SimonB2e23c822016-04-16 21:54:39 +0100596
Gilles Peskine8f073122018-11-27 15:58:47 +0100597 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
598 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
599 echo "You can either delete this directory manually, or force the test by rerunning"
600 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
601 exit 1
602 fi
603
Ronald Cron7a93ac52023-07-20 09:49:12 +0200604 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100605 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100606 echo "You can either delete or preserve your work, or force the test by rerunning the"
607 echo "script as: $0 --force"
608 exit 1
609 fi
SimonB2e23c822016-04-16 21:54:39 +0100610 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500611}
612
Gilles Peskine568f53a2021-07-12 18:16:01 +0200613pre_restore_files () {
614 # If the makefiles have been generated by a framework such as cmake,
615 # restore them from git. If the makefiles look like modifications from
616 # the ones checked into git, take care not to modify them. Whatever
617 # this function leaves behind is what the script will restore before
618 # each component.
619 case "$(head -n1 Makefile)" in
620 *[Gg]enerated*)
621 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
622 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
623 ;;
624 esac
625}
626
Gilles Peskinef83eb822020-03-30 20:11:39 +0200627pre_back_up () {
628 for x in $files_to_back_up; do
629 cp -p "$x" "$x$backup_suffix"
630 done
631}
632
Gilles Peskine8f073122018-11-27 15:58:47 +0100633pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100634 failure_count=0 # Number of failed components
635 last_failure_status=0 # Last failure status in this component
636
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100637 # See err_trap
638 previous_failure_status=0
639 previous_failed_command=
640 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100641 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100642
Gilles Peskine7c652162017-12-11 00:01:40 +0100643 start_red=
644 end_color=
645 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100646 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100647 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
648 start_red=$(printf '\033[31m')
649 end_color=$(printf '\033[0m')
650 ;;
651 esac
652 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100653
654 # Keep a summary of failures in a file. We'll print it out at the end.
655 failure_summary_file=$PWD/all-sh-failures-$$.log
656 : >"$failure_summary_file"
657
658 # Whether it makes sense to keep a component going after the specified
659 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200660 # This function normally receives the failing simple command
661 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
662 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100663 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200664 # False positives result in running things that can't be expected to
665 # work. False negatives result in things not running after something else
666 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100667 can_keep_going_after_failure () {
668 case "$1" in
669 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200670 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100671 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200672 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
673 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
674 *make*check*) true;;
675 "grep "*) true;;
676 "[ "*) true;;
677 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100678 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100679 esac
680 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100681
682 # This function runs if there is any error in a component.
683 # It must either exit with a nonzero status, or set
684 # last_failure_status to a nonzero value.
685 err_trap () {
686 # Save $? (status of the failing command). This must be the very
687 # first thing, before $? is overridden.
688 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100689 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100690
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100691 if [[ $last_failure_status -eq $previous_failure_status &&
692 "$failed_command" == "$previous_failed_command" &&
693 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
694 then
695 # The same command failed twice in a row, but this time one level
696 # less deep in the function call stack. This happens when the last
697 # command of a function returns a nonzero status, and the function
698 # returns that same status. Ignore the second failure.
699 previous_failure_funcall_depth=${#FUNCNAME[@]}
700 return
701 fi
702 previous_failure_status=$last_failure_status
703 previous_failed_command=$failed_command
704 previous_failure_funcall_depth=${#FUNCNAME[@]}
705
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 text="$current_section: $failed_command -> $last_failure_status"
707 echo "${start_red}^^^^$text^^^^${end_color}" >&2
708 echo "$text" >>"$failure_summary_file"
709
710 # If the command is fatal (configure or build command), stop this
711 # component. Otherwise (test command) keep the component running
712 # (run more tests from the same build).
713 if ! can_keep_going_after_failure "$failed_command"; then
714 exit $last_failure_status
715 fi
716 }
717
Gilles Peskine7c652162017-12-11 00:01:40 +0100718 final_report () {
719 if [ $failure_count -gt 0 ]; then
720 echo
721 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100722 echo "${start_red}FAILED: $failure_count components${end_color}"
723 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100724 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
725 elif [ -z "${1-}" ]; then
726 echo "SUCCESS :)"
727 fi
728 if [ -n "${1-}" ]; then
729 echo "Killed by SIG$1."
730 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100731 rm -f "$failure_summary_file"
732 if [ $failure_count -gt 0 ]; then
733 exit 1
734 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100735 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100736}
737
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200738# record_status() and if_build_succeeded() are kept temporarily for backward
739# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100740record_status () {
741 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100742}
Gilles Peskine7c652162017-12-11 00:01:40 +0100743if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100744 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100745}
746
Gilles Peskinea681c592020-03-28 21:27:40 +0100747# '! true' does not trigger the ERR trap. Arrange to trigger it, with
748# a reasonably informative error message (not just "$@").
749not () {
750 if "$@"; then
751 report_failed_command="! $*"
752 false
753 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200754 fi
755}
756
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200757pre_prepare_outcome_file () {
758 case "$MBEDTLS_TEST_OUTCOME_FILE" in
759 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
760 esac
761 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
762 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
763 fi
764}
765
Gilles Peskine8f073122018-11-27 15:58:47 +0100766pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200767 if [ $QUIET -eq 1 ]; then
768 return
769 fi
770
Gilles Peskine8f073122018-11-27 15:58:47 +0100771 msg "info: $0 configuration"
772 echo "MEMORY: $MEMORY"
773 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200774 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100775 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100776 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100777 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100778 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
779 echo "GNUTLS_CLI: $GNUTLS_CLI"
780 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100781 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
782 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
783}
Andres AG7770ea82016-10-10 15:46:20 +0100784
Andres AGd9eba4b2016-08-26 14:42:14 +0100785# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100786pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000787 # Build the list of variables to pass to output_env.sh.
788 set env
SimonB2e23c822016-04-16 21:54:39 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
791 # Require OpenSSL and GnuTLS if running any tests (as opposed to
792 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
793 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100794 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000795 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
796 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100797 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000798 export GNUTLS_CLI="$GNUTLS_CLI"
799 export GNUTLS_SERV="$GNUTLS_SERV"
800 # Avoid passing --seed flag in every call to ssl-opt.sh
801 if [ -n "${SEED-}" ]; then
802 export SEED
803 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200804 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000805 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200806 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
807 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000808 ;;
809 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200810
Gilles Peskine87964262019-01-06 22:40:00 +0000811 case " $RUN_COMPONENTS " in
812 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
813 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100814
Gilles Peskine87964262019-01-06 22:40:00 +0000815 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200816 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000817 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100818
Gilles Peskine87964262019-01-06 22:40:00 +0000819 case " $RUN_COMPONENTS " in
820 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
821 esac
822
823 case " $RUN_COMPONENTS " in
824 *" test_zeroize "*) check_tools "gdb";;
825 esac
826
827 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000828 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000829 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
830 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200831 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000832 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
833 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200834 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
835 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
836 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000837 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000838
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200839 # past this point, no call to check_tool, only printing output
840 if [ $QUIET -eq 1 ]; then
841 return
842 fi
843
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000844 msg "info: output_env.sh"
845 case $RUN_COMPONENTS in
846 *_armcc*)
847 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
848 *) set "$@" RUN_ARMCC=0;;
849 esac
850 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100851}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100852
Gilles Peskine1570b592021-04-22 01:10:12 +0200853pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200854 # since make doesn't have proper dependencies, remove any possibly outdate
855 # file that might be around before generating fresh ones
856 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200857 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200858 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200859 else
860 make generated_files
861 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200862}
863
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000864clang_version() {
865 if command -v clang > /dev/null ; then
866 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
867 else
868 echo 0 # report version 0 for "no clang"
869 fi
870}
871
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200872################################################################
873#### Helpers for components using libtestdriver1
874################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100875
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200876# How to use libtestdriver1
877# -------------------------
878#
879# 1. Define the list algorithms and key types to accelerate,
880# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
881# Examples:
882# - loc_accel_list="ALG_JPAKE"
883# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200884# 2. Make configurations changes for the driver and/or main libraries.
885# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
886# can be either "default" to start with the default config, or a name
887# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200888# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200889# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
890# These changes affect both the driver and the main libraries.
891# (Note: they need to have the same set of PSA_WANT symbols, as that
892# determines the ABI between them.)
893# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
894# main libraries. Typically, you want to disable the module(s) that are
895# being accelerated. You may need to also disable modules that depend
896# on them or options that are not supported with drivers.
897# 2d. On top of psa/crypto_config.h, the driver library uses its own config
898# file: tests/include/test/drivers/config_test_driver.h. You usually
899# don't need to edit it: using loc_extra_list (see below) is preferred.
900# However, when there's no PSA symbol for what you want to enable,
901# calling scripts/config.py on this file remains the only option.
902# 3. Build the driver library, then the main libraries, test, and programs.
903# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
904# need to enable more algorithms here, typically hash algorithms when
905# accelerating some signature algorithms (ECDSA, RSAv2). This is done
906# by passing a 2nd argument listing the extra algorithms.
907# Example:
908# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
909# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800910# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200911# additional arguments will be passed to make: this can be useful if
912# you don't want to build everything when iterating during development.
913# Example:
914# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
915# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200916
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200917# Adjust the configuration - for both libtestdriver1 and main library,
918# as they should have the same PSA_WANT macros.
919helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200920 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200921 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200922 if [ "$base_config" != "default" ]; then
923 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200924 fi
925
926 # Enable PSA-based config (necessary to use drivers)
927 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
928
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200929 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
930 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
931 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000932
933 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
934 # otherwise we will end up running multithreaded tests without mutexes to protect them.
935 if scripts/config.py get MBEDTLS_THREADING_C; then
936 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
937 fi
938
939 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
940 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
941 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200942}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100943
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100944# Build the drivers library libtestdriver1.a (with ASan).
945#
946# Parameters:
947# 1. a space-separated list of things to accelerate;
948# 2. optional: a space-separate list of things to also support.
949# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
950helper_libtestdriver1_make_drivers() {
951 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
952 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
953}
954
955# Build the main libraries, programs and tests,
956# linking to the drivers library (with ASan).
957#
958# Parameters:
959# 1. a space-separated list of things to accelerate;
960# *. remaining arguments if any are passed directly to make
961# (examples: lib, -C tests test_suite_xxx, etc.)
962# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
963helper_libtestdriver1_make_main() {
964 loc_accel_list=$1
965 shift
966
967 # we need flags both with and without the LIBTESTDRIVER1_ prefix
968 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
969 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
970 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" "$@"
971}
972
Valerio Setti9022f712024-06-27 07:59:39 +0200973# Set some default values $CONFIG_H in order to build server or client sides
974# in PSASIM. There is only 1 mandatory parameter:
975# - $1: target which can be "client" or "server"
Valerio Settid8b59372024-07-02 12:02:25 +0200976helper_psasim_config() {
Valerio Settid1b6ef12024-05-07 16:00:21 +0200977 TARGET=$1
Valerio Settid1b6ef12024-05-07 16:00:21 +0200978
Valerio Settid1b6ef12024-05-07 16:00:21 +0200979 if [ "$TARGET" == "client" ]; then
980 scripts/config.py full
981 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
982 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
983 # Dynamic secure element support is a deprecated feature and it is not
984 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
985 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
986 # Disable potentially problematic features
987 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
988 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
989 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
990 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
991 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100992 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200993 else
994 scripts/config.py crypto_full
995 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100996 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
997 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
998 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
999 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +02001000 fi
Valerio Setti9022f712024-06-27 07:59:39 +02001001}
Valerio Settid1b6ef12024-05-07 16:00:21 +02001002
Valerio Setti9022f712024-06-27 07:59:39 +02001003# Helper to build the libraries for client/server in PSASIM. If the server is
1004# being built, then it builds also the final executable.
1005# There is only 1 mandatory parameter:
1006# - $1: target which can be "client" or "server"
1007helper_psasim_build() {
1008 TARGET=$1
1009 shift
1010 TARGET_LIB=${TARGET}_libs
1011
1012 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
1013
1014 # Build also the server application after its libraries have been built.
1015 if [ "$TARGET" == "server" ]; then
1016 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_server
1017 fi
Valerio Settid1b6ef12024-05-07 16:00:21 +02001018}
1019
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +01001020################################################################
1021#### Configuration helpers
1022################################################################
1023
Valerio Settib2fd6732023-08-15 17:10:47 +02001024# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +02001025# The function optionally accepts 1 parameter: a space-separated list of the
1026# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +02001027helper_disable_builtin_curves() {
1028 allowed_list="${1:-}"
1029 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
1030
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001031 for curve in $allowed_list; do
1032 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001033 done
1034}
1035
1036# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1037# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1038# in the following helpers.
1039helper_get_psa_curve_list () {
1040 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001041 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1042 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001043 done
1044
1045 echo "$loc_list"
1046}
1047
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001048# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1049# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1050# in the following helpers.
1051helper_get_psa_dh_group_list () {
1052 loc_list=""
1053 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1054 loc_list="$loc_list $item"
1055 done
1056
1057 echo "$loc_list"
1058}
1059
Valerio Settib2fd6732023-08-15 17:10:47 +02001060# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001061# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001062# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001063helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001064 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001065 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001066 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 +02001067 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1068 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001069 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1070 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001071 fi
1072 done
1073
1074 echo "$loc_list"
1075}
1076
Valerio Setti9022f712024-06-27 07:59:39 +02001077# Helper function for controlling (start & stop) the psasim server.
1078helper_psasim_server() {
1079 OPERATION=$1
1080 if [ "$OPERATION" == "start" ]; then
1081 (
1082 cd tests
1083 msg "start server"
1084 psa-client-server/psasim/test/start_server.sh
1085 )
1086 else
1087 (
1088 cd tests
1089 msg "terminate server and cleanup"
1090 psa-client-server/psasim//test/kill_server.sh
1091 )
1092 fi
1093}
1094
Gilles Peskine192c72f2017-12-21 15:59:21 +01001095################################################################
1096#### Basic checks
1097################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001098
Ronald Cron5b41a652024-07-03 08:59:47 +02001099export PSA_CORE_PATH="tf-psa-crypto/core"
Ronald Cron709bbf02024-07-03 07:59:30 +02001100export BUILTIN_SRC_PATH="tf-psa-crypto/drivers/builtin/src"
1101
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001102#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001103# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001104#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001105# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001106# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001107# 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 +02001108# time, so start with a GCC build).
1109# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001110#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001111# Indicative running times are given for reference.
1112
Gilles Peskine8f073122018-11-27 15:58:47 +01001113component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001114 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001115 tests/scripts/recursion.pl library/*.c
Ronald Cron5b41a652024-07-03 08:59:47 +02001116 tests/scripts/recursion.pl ${PSA_CORE_PATH}/*.c
Ronald Cron709bbf02024-07-03 07:59:30 +02001117 tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001118}
Janos Follathb72c6782016-07-19 14:54:17 +01001119
Gilles Peskine67debb62021-05-18 16:09:50 +02001120component_check_generated_files () {
1121 msg "Check: check-generated-files, files generated with make" # 2s
1122 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001123 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001124
1125 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001126 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001127 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001128 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001129
1130 msg "Check: check-generated-files -u, files absent" # 2s
1131 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001132 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001133 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001134 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001135
1136 # This component ends with the generated files present in the source tree.
1137 # This is necessary for subsequent components!
1138}
1139
Gilles Peskine8f073122018-11-27 15:58:47 +01001140component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001141 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001142 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001143}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001144
Gilles Peskine8f073122018-11-27 15:58:47 +01001145component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001146 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001147 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001148}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001149
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001150component_check_changelog () {
1151 msg "Check: changelog entries" # < 1s
1152 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001153 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001154 if [ -e ChangeLog.new ]; then
1155 # Show the diff for information. It isn't an error if the diff is
1156 # non-empty.
1157 diff -u ChangeLog ChangeLog.new || true
1158 rm ChangeLog.new
1159 fi
1160}
1161
Gilles Peskine8f073122018-11-27 15:58:47 +01001162component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001163 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001164 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001165}
Darryl Greena07039c2018-03-13 16:48:16 +00001166
Gilles Peskine895868b2019-09-19 21:30:05 +02001167component_check_test_cases () {
1168 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001169 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001170 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001171 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001172 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001173 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001174 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001175 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001176}
1177
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001178component_check_test_dependencies () {
1179 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001180 # The purpose of this component is to catch unjustified dependencies on
1181 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1182 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1183 # MBEDTLS_PSA_xxx).
1184 #
1185 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1186 # this component is meant to catch. However a few of them are justified,
1187 # mostly by the absence of a PSA equivalent, so this component includes a
1188 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001189
1190 found="check-test-deps-found-$$"
1191 expected="check-test-deps-expected-$$"
1192
1193 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001194 grep 'depends_on' \
1195 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001196 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001197 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001198 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001199
Yanray Wang18040ed2023-11-23 21:29:56 +08001200 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001201 rm -f $expected
1202 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1203 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001204 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1205 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001206 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1207 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001208 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1209 # the test code and that's probably the most convenient way of achieving
1210 # the test's goal.
1211 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1212 # No PSA equivalent - we should probably have one in the future.
1213 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1214 # No PSA equivalent - needed by some init tests
1215 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001216 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001217 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001218
1219 # Compare reality with expectation.
1220 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001221 #
1222 # The output should be empty. When it's not:
1223 # - Each '+' line is a macro that was found but not expected. You want to
1224 # find where that macro occurs, and either replace it with PSA macros, or
1225 # add it to the exceptions list above with a justification.
1226 # - Each '-' line is a macro that was expected but not found; it means the
1227 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001228 diff -U0 $expected $found
1229
1230 rm $found $expected
1231}
1232
Gilles Peskine8f073122018-11-27 15:58:47 +01001233component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001234 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001235 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001236}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001237
Gilles Peskine192c72f2017-12-21 15:59:21 +01001238
Gilles Peskine636c26a2020-03-04 20:46:15 +01001239
Gilles Peskine192c72f2017-12-21 15:59:21 +01001240################################################################
1241#### Build and test many configurations and targets
1242################################################################
1243
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001244component_test_default_out_of_box () {
1245 msg "build: make, default config (out-of-box)" # ~1min
1246 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001247 # Disable fancy stuff
1248 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001249
1250 msg "test: main suites make, default config (out-of-box)" # ~10s
1251 make test
1252
1253 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001254 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001255
1256 msg "program demos: make, default config (out-of-box)" # ~10s
1257 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001258}
1259
Gilles Peskine8f073122018-11-27 15:58:47 +01001260component_test_default_cmake_gcc_asan () {
1261 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001262 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1263 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001264
Gilles Peskine8f073122018-11-27 15:58:47 +01001265 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1266 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001267
Gilles Peskine82b27272019-06-14 18:27:03 +02001268 msg "program demos (ASan build)" # ~10s
1269 tests/scripts/run_demos.py
1270
Gilles Peskine97bea012020-04-23 23:37:45 +02001271 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001272 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001273
Gilles Peskine6848d172023-11-02 19:58:03 +01001274 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001275 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001276
Gilles Peskine8f073122018-11-27 15:58:47 +01001277 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001278 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001279
Gilles Peskine8f073122018-11-27 15:58:47 +01001280 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001281 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001282
1283 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001284 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001285}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001286
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001287component_test_default_cmake_gcc_asan_new_bignum () {
1288 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001289 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001290 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001291 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001292
1293 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1294 make test
1295
1296 msg "test: selftest (ASan build)" # ~ 10s
1297 programs/test/selftest
1298
1299 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1300 tests/ssl-opt.sh
1301
1302 msg "test: compat.sh (ASan build)" # ~ 6 min
1303 tests/compat.sh
1304
1305 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1306 tests/context-info.sh
1307}
1308
Hanno Becker01635512019-02-26 14:27:09 +00001309component_test_full_cmake_gcc_asan () {
1310 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001311 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001312 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1313 make
1314
1315 msg "test: main suites (inc. selftests) (full config, ASan build)"
1316 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001317
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001318 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001319 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001320
Gilles Peskine636c26a2020-03-04 20:46:15 +01001321 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001322 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001323
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001324 # Note: the next two invocations cover all compat.sh test cases.
1325 # We should use the same here and in basic-build-test.sh.
1326 msg "test: compat.sh: default version (full config, ASan build)"
1327 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001328
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001329 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1330 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001331
1332 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001333 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001334}
1335
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001336
1337component_test_full_cmake_gcc_asan_new_bignum () {
1338 msg "build: full config, cmake, gcc, ASan"
1339 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001340 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001341 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001342 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001343
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001344 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001345 make test
1346
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001347 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001348 programs/test/selftest
1349
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001350 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001351 tests/ssl-opt.sh
1352
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001353 # Note: the next two invocations cover all compat.sh test cases.
1354 # We should use the same here and in basic-build-test.sh.
1355 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1356 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001357
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001358 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1359 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001360
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001361 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001362 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001363}
1364
Ronald Cronc3623db2020-10-29 10:51:32 +01001365component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001366 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001367 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001368 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1369 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1370 make
1371
1372 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1373 make test
1374}
1375
David Horstmann4a48bec2024-03-13 15:42:31 +00001376component_test_psa_assume_exclusive_buffers () {
1377 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001378 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001379 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001380 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1381 make
1382
David Horstmann4a48bec2024-03-13 15:42:31 +00001383 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001384 make test
1385}
1386
Gilles Peskinea3548672021-06-17 11:37:52 +02001387# check_renamed_symbols HEADER LIB
1388# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1389# name is LIB.
1390check_renamed_symbols () {
1391 ! nm "$2" | sed 's/.* //' |
1392 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1393}
1394
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001395component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001396 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001397 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001398 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1399 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1400 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1401 # We can only compile, not link, since our test and sample programs
1402 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1403 # is active.
1404 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001405
1406 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1407 # version is not present.
1408 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001409 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001410}
1411
Ryan Everettdaa322a2024-04-18 16:48:55 +01001412component_test_no_rsa_key_pair_generation() {
1413 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001414 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001415 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001416 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001417 make
1418
Ryan Everettdaa322a2024-04-18 16:48:55 +01001419 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001420 make test
1421}
1422
Gilles Peskine782f4112018-11-27 16:11:09 +01001423component_test_ref_configs () {
1424 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001425 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1426 # want to re-generate generated files that depend on it, quite correctly.
1427 # However this doesn't work as the generation script expects a specific
1428 # format for mbedtls_config.h, which the other files don't follow. Also,
1429 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001430 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001431 # whether they're on or off. So, disable cmake's (over-sensitive here)
1432 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001433 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001434 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001435 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001436}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001437
Gilles Peskine8f073122018-11-27 15:58:47 +01001438component_test_no_renegotiation () {
1439 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001440 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001441 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001442 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001443
Gilles Peskine8f073122018-11-27 15:58:47 +01001444 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1445 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001446
Gilles Peskine8f073122018-11-27 15:58:47 +01001447 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001448 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001449}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001450
Gilles Peskine636c26a2020-03-04 20:46:15 +01001451component_test_no_pem_no_fs () {
1452 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1453 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1454 scripts/config.py unset MBEDTLS_FS_IO
1455 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1456 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001457 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001458 make
1459
1460 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1461 make test
1462
1463 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001464 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001465}
1466
Gilles Peskine8f073122018-11-27 15:58:47 +01001467component_test_rsa_no_crt () {
1468 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001469 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001470 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001471 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001472
Gilles Peskine8f073122018-11-27 15:58:47 +01001473 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1474 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001477 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001478
Gilles Peskine8f073122018-11-27 15:58:47 +01001479 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001480 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001481
1482 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001483 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001484}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001485
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001486component_test_no_ctr_drbg_classic () {
1487 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001488 scripts/config.py full
1489 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001490 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001491 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001492
Dave Rodgman17127e92023-12-14 16:42:48 +00001493 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001494 make
1495
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001496 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497 make test
1498
Gilles Peskineba749042021-01-13 20:02:03 +01001499 # In this configuration, the TLS test programs use HMAC_DRBG.
1500 # The SSL tests are slow, so run a small subset, just enough to get
1501 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001503 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001504
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001505 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001506 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001507}
1508
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001509component_test_no_ctr_drbg_use_psa () {
1510 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001511 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1513 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001514
Dave Rodgman17127e92023-12-14 16:42:48 +00001515 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001516 make
1517
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001518 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1519 make test
1520
1521 # In this configuration, the TLS test programs use HMAC_DRBG.
1522 # The SSL tests are slow, so run a small subset, just enough to get
1523 # confidence that the SSL code copes with HMAC_DRBG.
1524 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001525 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001526
1527 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001528 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001529}
1530
1531component_test_no_hmac_drbg_classic () {
1532 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1533 scripts/config.py full
1534 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1535 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1536 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001537 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001538
Dave Rodgman17127e92023-12-14 16:42:48 +00001539 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540 make
1541
1542 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001543 make test
1544
Gilles Peskinea2224342020-11-19 22:14:34 +01001545 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1546 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1547 # instead.
1548 # Test SSL with non-deterministic ECDSA. Only test features that
1549 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001550 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001551 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001552
1553 # To save time, only test one protocol version, since this part of
1554 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001556 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001557}
1558
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001559component_test_no_hmac_drbg_use_psa () {
1560 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1561 scripts/config.py full
1562 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1563 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1564 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1565
Dave Rodgman17127e92023-12-14 16:42:48 +00001566 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001567 make
1568
1569 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1570 make test
1571
1572 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1573 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1574 # instead.
1575 # Test SSL with non-deterministic ECDSA. Only test features that
1576 # might be affected by how ECDSA signature is performed.
1577 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001578 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001579
1580 # To save time, only test one protocol version, since this part of
1581 # the protocol is identical in (D)TLS up to 1.2.
1582 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001583 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584}
1585
1586component_test_psa_external_rng_no_drbg_classic () {
1587 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1588 scripts/config.py full
1589 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001590 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001591 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001592 scripts/config.py unset MBEDTLS_ENTROPY_C
1593 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1594 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001595 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1596 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1597 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001598 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1599 # the SSL test programs don't have an RNG and can't work. Explicitly
1600 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001601 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001602
1603 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1604 make test
1605
Gilles Peskine8eb29432021-02-03 20:07:11 +01001606 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001607 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001608}
1609
1610component_test_psa_external_rng_no_drbg_use_psa () {
1611 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001612 scripts/config.py full
1613 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001614 scripts/config.py unset MBEDTLS_ENTROPY_C
1615 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1616 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001617 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1618 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1619 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001620 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001621
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001622 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001623 make test
1624
Gilles Peskine8eb29432021-02-03 20:07:11 +01001625 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001626 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001627}
1628
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001629component_test_psa_external_rng_use_psa_crypto () {
1630 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1631 scripts/config.py full
1632 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1633 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1634 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001635 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001636
1637 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1638 make test
1639
1640 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1641 tests/ssl-opt.sh -f 'Default\|opaque'
1642}
1643
Gilles Peskine801c4332023-04-28 21:04:28 +02001644component_test_psa_inject_entropy () {
1645 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1646 scripts/config.py full
1647 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1648 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1649 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1650 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1651 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1652 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001653 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 +02001654
1655 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1656 make test
1657}
1658
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001659component_test_sw_inet_pton () {
1660 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1661
1662 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1663 scripts/config.py set MBEDTLS_TEST_HOOKS
1664 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1665
1666 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1667 make test
1668}
1669
Valerio Settia41654d2024-02-08 10:33:11 +01001670component_full_no_pkparse_pkwrite() {
1671 msg "build: full without pkparse and pkwrite"
1672
1673 scripts/config.py crypto_full
1674 scripts/config.py unset MBEDTLS_PK_PARSE_C
1675 scripts/config.py unset MBEDTLS_PK_WRITE_C
1676
Valerio Settia41654d2024-02-08 10:33:11 +01001677 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1678
1679 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
Ronald Cron709bbf02024-07-03 07:59:30 +02001680 not grep mbedtls_pk_parse_key ${BUILTIN_SRC_PATH}/pkparse.o
1681 not grep mbedtls_pk_write_key_der ${BUILTIN_SRC_PATH}/pkwrite.o
Valerio Settia41654d2024-02-08 10:33:11 +01001682
1683 msg "test: full without pkparse and pkwrite"
1684 make test
1685}
1686
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001687component_test_crypto_full_md_light_only () {
1688 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001689 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001690
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001691 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001692 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001693 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001694 scripts/config.py unset MBEDTLS_HKDF_C
1695 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001696 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001697 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001698 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001699 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001700 # Disable things that would auto-enable MD_C
1701 scripts/config.py unset MBEDTLS_PKCS5_C
1702
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001703 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1704 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001705 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001706
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001707 # Make sure we don't have the HMAC functions, but the hashing functions
Ronald Cron709bbf02024-07-03 07:59:30 +02001708 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1709 grep mbedtls_md ${BUILTIN_SRC_PATH}/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001710
1711 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001712 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001713}
1714
Ronald Cron8dbea482024-05-23 16:04:11 +02001715component_test_full_no_cipher () {
1716 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001717
1718 scripts/config.py full
1719 scripts/config.py unset MBEDTLS_CIPHER_C
1720
Ronald Cron8dbea482024-05-23 16:04:11 +02001721 # The built-in implementation of the following algs/key-types depends
1722 # on CIPHER_C so we disable them.
1723 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1724 # so we keep them enabled.
1725 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1726 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1727 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1729 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1730 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1731 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1732 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1733 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1734 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1735 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1736
Valerio Settic84d9402023-10-23 14:58:25 +02001737 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001738 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001739 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001740
Gilles Peskine21570cf2023-12-22 11:49:50 +01001741 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001742
Valerio Setti7e710e82023-08-25 09:14:15 +02001743 # Ensure that CIPHER_C was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02001744 not grep mbedtls_cipher_init ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti7e710e82023-08-25 09:14:15 +02001745
Ronald Cron8dbea482024-05-23 16:04:11 +02001746 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001747 make test
1748}
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
Ronald Cron5b41a652024-07-03 08:59:47 +02001797 not grep mbedtls_psa_cipher ${PSA_CORE_PATH}/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001798
1799 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001800 make test
1801}
1802
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001803component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001804 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001805
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001806 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001807 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001808 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001809 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001810 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001811 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1812 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001813 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001814 scripts/config.py unset MBEDTLS_GCM_C
1815 scripts/config.py unset MBEDTLS_CCM_C
1816 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001817 #Disable TLS 1.3 (as no AEAD)
1818 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001819 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1820 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1821 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001822 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney67338c02024-05-09 15:21:14 +01001823 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001824 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001825 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001826 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001827 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1828 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001829 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001830 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001831 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001832
Przemek Stekiel9550c052022-09-28 09:51:55 +02001833 make
1834
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001835 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001836 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001837
1838 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001839}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001840
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001841component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001842 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001843
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001844 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001845 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001846 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001847 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001848 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001849 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1850 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001851 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001852 scripts/config.py unset MBEDTLS_GCM_C
1853 scripts/config.py unset MBEDTLS_CCM_C
1854 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001855 #Disable TLS 1.3 (as no AEAD)
1856 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001857 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney62586212024-04-26 17:01:16 +01001858 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001859 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001860 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001861 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001862 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001863 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001864 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001865 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001866
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001867 make
1868
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001869 msg "test: default with only CBC-legacy cipher use psa"
1870 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001871
1872 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1873 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001874}
1875
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001876component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001877 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001878
1879 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001880 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001881 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001882 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001883 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001884 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1885 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001886 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001887 scripts/config.py unset MBEDTLS_GCM_C
1888 scripts/config.py unset MBEDTLS_CCM_C
1889 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001890 #Disable TLS 1.3 (as no AEAD)
1891 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001892 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001893 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001894 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1895 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1896 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001897 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001898 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001899 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001900 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001901
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001902 make
1903
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001904 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001905 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001906
1907 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1908 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001909}
1910
Valerio Setti9f0ec532022-11-08 13:03:24 +01001911# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1912# that we could use for interop testing. However, we now have sort of two
1913# implementations ourselves: one using PSA, the other not. At least test that
1914# these two interoperate with each other.
1915component_test_tls1_2_ecjpake_compatibility() {
1916 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1917 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001918 # Explicitly make lib first to avoid a race condition:
1919 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1920 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001921 make -C programs ssl/ssl_server2 ssl/ssl_client2
1922 cp programs/ssl/ssl_server2 s2_no_use_psa
1923 cp programs/ssl/ssl_client2 c2_no_use_psa
1924
1925 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1926 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1927 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001928 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001929 make -C programs ssl/ssl_server2 ssl/ssl_client2
1930 make -C programs test/udp_proxy test/query_compile_time_config
1931
Valerio Setti70e02902022-12-02 16:21:56 +01001932 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1933 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1934 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1935 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1936 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1937 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1938 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1939 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 +01001940
1941 rm s2_no_use_psa c2_no_use_psa
1942}
1943
Gilles Peskine636c26a2020-03-04 20:46:15 +01001944component_test_everest () {
1945 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001946 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1947 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1948 make
1949
1950 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1951 make test
1952
Gilles Peskine6848d172023-11-02 19:58:03 +01001953 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001954 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001955
Gilles Peskine636c26a2020-03-04 20:46:15 +01001956 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001957 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001958
1959 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1960 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001961 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001962}
1963
Gilles Peskined3beca92020-07-03 00:15:37 +02001964component_test_everest_curve25519_only () {
1965 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001966 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02001967 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1968 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001969 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1970 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
1971 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02001972 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1973 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001974 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001975 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
1976
Gilles Peskined3beca92020-07-03 00:15:37 +02001977 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001978 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001979 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
1980 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02001981
Dave Rodgman17127e92023-12-14 16:42:48 +00001982 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02001983
1984 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1985 make test
1986}
1987
Gilles Peskine8f073122018-11-27 15:58:47 +01001988component_test_small_ssl_out_content_len () {
1989 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001990 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1991 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00001992 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001993 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001994
Gilles Peskine8f073122018-11-27 15:58:47 +01001995 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001996 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01001997}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001998
Gilles Peskine8f073122018-11-27 15:58:47 +01001999component_test_small_ssl_in_content_len () {
2000 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002001 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2002 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002003 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002004 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002005
Gilles Peskine8f073122018-11-27 15:58:47 +01002006 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002007 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002008}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002009
Gilles Peskine8f073122018-11-27 15:58:47 +01002010component_test_small_ssl_dtls_max_buffering () {
2011 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002012 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002013 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002014 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002015
Gilles Peskine8f073122018-11-27 15:58:47 +01002016 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002017 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 +01002018}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002019
Gilles Peskine8f073122018-11-27 15:58:47 +01002020component_test_small_mbedtls_ssl_dtls_max_buffering () {
2021 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002022 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002023 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002024 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002025
Gilles Peskine8f073122018-11-27 15:58:47 +01002026 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002027 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002028}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002029
Gilles Peskine75cc7712019-09-06 19:47:17 +02002030component_test_psa_collect_statuses () {
2031 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002032 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002033 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002034 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002035 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002036 rm -f tests/statuses.log
2037}
2038
Gilles Peskine8f073122018-11-27 15:58:47 +01002039component_test_full_cmake_clang () {
2040 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002041 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002042 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 +01002043 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002044
k-stachowiak0291cb72019-06-26 15:52:12 +02002045 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002046 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002047
Gilles Peskineda6017c2022-10-30 21:02:40 +01002048 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2049 programs/test/cpp_dummy_build
2050
Gilles Peskine6848d172023-11-02 19:58:03 +01002051 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002052 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002053
Gilles Peskine82b27272019-06-14 18:27:03 +02002054 msg "program demos (full config, clang)" # ~10s
2055 tests/scripts/run_demos.py
2056
k-stachowiak0291cb72019-06-26 15:52:12 +02002057 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002058 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002059
Gilles Peskine8f073122018-11-27 15:58:47 +01002060 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002061 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002062}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002063
Gilles Peskine0c671602022-11-29 16:01:41 +01002064skip_suites_without_constant_flow () {
2065 # Skip the test suites that don't have any constant-flow annotations.
2066 # This will need to be adjusted if we ever start declaring things as
2067 # secret from macros or functions inside tests/include or tests/src.
2068 SKIP_TEST_SUITES=$(
2069 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2070 sed 's/test_suite_//; s/\.function$//' |
2071 tr '\n' ,)
2072 export SKIP_TEST_SUITES
2073}
2074
Dave Rodgman246210e2023-07-31 18:07:44 +01002075skip_all_except_given_suite () {
2076 # Skip all but the given test suite
2077 SKIP_TEST_SUITES=$(
2078 ls -1 tests/suites/test_suite_*.function |
2079 grep -v $1.function |
2080 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2081 tr '\n' ,)
2082 export SKIP_TEST_SUITES
2083}
2084
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002085component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002086 # This tests both (1) accesses to undefined memory, and (2) branches or
2087 # memory access depending on secret values. To distinguish between those:
2088 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2089 # - or alternatively, change the build type to MemSanDbg, which enables
2090 # origin tracking and nicer stack traces (which are useful for debugging
2091 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002092 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2093 scripts/config.py full
2094 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2095 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2096 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2097 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2098 make
2099
2100 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2101 make test
2102}
2103
2104component_test_memsan_constant_flow_psa () {
2105 # This tests both (1) accesses to undefined memory, and (2) branches or
2106 # memory access depending on secret values. To distinguish between those:
2107 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2108 # - or alternatively, change the build type to MemSanDbg, which enables
2109 # origin tracking and nicer stack traces (which are useful for debugging
2110 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002111 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002112 scripts/config.py full
2113 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2114 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2115 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2116 make
2117
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002118 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002119 make test
2120}
2121
Bence Szépkúti0354d042023-12-06 16:14:37 +01002122component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002123 # This tests both (1) everything that valgrind's memcheck usually checks
2124 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2125 # etc.) and (2) branches or memory access depending on secret values,
2126 # which will be reported as uninitialized memory. To distinguish between
2127 # secret and actually uninitialized:
2128 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2129 # - or alternatively, build with debug info and manually run the offending
2130 # test suite with valgrind --track-origins=yes, then check if the origin
2131 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002132 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2133 scripts/config.py full
2134 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2135 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002136 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002137 cmake -D CMAKE_BUILD_TYPE:String=Release .
2138 make
2139
2140 # this only shows a summary of the results (how many of each type)
2141 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002142 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002143 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002144
2145 # Test asm path in constant time module - by default, it will test the plain C
2146 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2147 msg "test: valgrind asm constant_time"
2148 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2149 skip_all_except_given_suite test_suite_constant_time
2150 cmake -D CMAKE_BUILD_TYPE:String=Release .
2151 make clean
2152 make
2153 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002154}
2155
Bence Szépkúti0354d042023-12-06 16:14:37 +01002156component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002157 # This tests both (1) everything that valgrind's memcheck usually checks
2158 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2159 # etc.) and (2) branches or memory access depending on secret values,
2160 # which will be reported as uninitialized memory. To distinguish between
2161 # secret and actually uninitialized:
2162 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2163 # - or alternatively, build with debug info and manually run the offending
2164 # test suite with valgrind --track-origins=yes, then check if the origin
2165 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002166 msg "build: cmake release GCC, full config with constant flow testing"
2167 scripts/config.py full
2168 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002169 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002170 cmake -D CMAKE_BUILD_TYPE:String=Release .
2171 make
2172
2173 # this only shows a summary of the results (how many of each type)
2174 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002175 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002176 make memcheck
2177}
2178
Janos Follath9338cac2023-10-04 18:55:39 +01002179component_test_tsan () {
2180 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002181 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002182 scripts/config.py set MBEDTLS_THREADING_C
2183 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002184 # Self-tests do not currently use multiple threads.
2185 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002186
Ryan6caf84f2024-03-05 13:57:00 +00002187 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2188 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2189
Janos Follath9338cac2023-10-04 18:55:39 +01002190 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2191 make
2192
2193 msg "test: main suites (TSan)"
2194 make test
2195}
2196
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002197component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002198 # Test that removing the deprecated features from the default
2199 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002200 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2201 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002202 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002203
2204 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2205 make test
2206}
2207
2208component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002209 msg "build: make, full_no_deprecated config" # ~ 30s
2210 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002211 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002212
Gilles Peskine30de2e82020-04-20 21:39:22 +02002213 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002214 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002215
2216 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2217 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002218}
2219
Gilles Peskine8386ea22020-04-30 09:07:29 +02002220component_test_full_no_deprecated_deprecated_warning () {
2221 # Test that there is nothing deprecated in "full_no_deprecated".
2222 # A deprecated feature would trigger a warning (made fatal) from
2223 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002224 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2225 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002226 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2227 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002228 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002229
Gilles Peskine30de2e82020-04-20 21:39:22 +02002230 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002231 make test
2232}
2233
Gilles Peskine8386ea22020-04-30 09:07:29 +02002234component_test_full_deprecated_warning () {
2235 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2236 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002237 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002238 scripts/config.py full
2239 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002240 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002241 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2242 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002243 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002244
Gilles Peskine8386ea22020-04-30 09:07:29 +02002245 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2246 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2247 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002248 # Expect warnings from '#warning' directives in check_config.h and
2249 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002250 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 +01002251
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002252 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2253 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002254
2255 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2256 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002257}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002258
Gilles Peskineec541fe2020-01-31 14:24:14 +01002259# Check that the specified libraries exist and are empty.
2260are_empty_libraries () {
2261 nm "$@" >/dev/null 2>/dev/null
2262 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2263}
2264
2265component_build_crypto_default () {
2266 msg "build: make, crypto only"
2267 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002268 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002269 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002270}
2271
2272component_build_crypto_full () {
2273 msg "build: make, crypto only, full config"
2274 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002275 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002276 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002277}
2278
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002279component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002280 msg "build: make, config for PSA crypto service"
2281 scripts/config.py crypto
2282 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2283 # Disable things that are not needed for just cryptography, to
2284 # reach a configuration that would be typical for a PSA cryptography
2285 # service providing all implemented PSA algorithms.
2286 # System stuff
2287 scripts/config.py unset MBEDTLS_ERROR_C
2288 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002289 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002290 # Crypto stuff with no PSA interface
2291 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002292 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002293 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002294 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002295 scripts/config.py unset MBEDTLS_NIST_KW_C
2296 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2297 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2298 scripts/config.py unset MBEDTLS_PKCS12_C
2299 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002300 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2301 # in PSA code to work with RSA keys. We don't require users to set those:
2302 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002303 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002304 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002305 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002306 make CFLAGS='-O1 -Werror' all test
2307 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2308}
2309
Gilles Peskineec541fe2020-01-31 14:24:14 +01002310component_build_crypto_baremetal () {
2311 msg "build: make, crypto only, baremetal config"
2312 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002313 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002314 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002315}
Daniel Axtens446af202020-09-02 21:30:13 +10002316support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002317 support_build_baremetal "$@"
2318}
2319
2320component_build_baremetal () {
2321 msg "build: make, baremetal config"
2322 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002323 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002324}
2325support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002326 # Older Glibc versions include time.h from other headers such as stdlib.h,
2327 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2328 # problem, Ubuntu 18.04 is ok.
2329 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2330}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002331
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002332# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002333component_test_depends_py_cipher_id () {
2334 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002335 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002336}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002337
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002338component_test_depends_py_cipher_chaining () {
2339 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002340 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002341}
2342
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002343component_test_depends_py_cipher_padding () {
2344 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002345 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002346}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002347
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002348component_test_depends_py_curves () {
2349 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002350 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002351}
2352
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002353component_test_depends_py_hashes () {
2354 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002355 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002356}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002357
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002358component_test_depends_py_kex () {
2359 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002360 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002361}
2362
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002363component_test_depends_py_pkalgs () {
2364 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002365 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002366}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002367
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002368# PSA equivalents of the depends.py tests
2369component_test_depends_py_cipher_id_psa () {
2370 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002371 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002372}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002373
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002374component_test_depends_py_cipher_chaining_psa () {
2375 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002376 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002377}
2378
2379component_test_depends_py_cipher_padding_psa () {
2380 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002381 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002382}
2383
2384component_test_depends_py_curves_psa () {
2385 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002386 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002387}
2388
2389component_test_depends_py_hashes_psa () {
2390 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002391 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002392}
2393
2394component_test_depends_py_kex_psa () {
2395 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002396 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002397}
2398
2399component_test_depends_py_pkalgs_psa () {
2400 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002401 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002402}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002403
Valerio Setti6bed64e2024-01-17 15:21:44 +01002404component_test_psa_crypto_config_ffdh_2048_only () {
2405 msg "build: full config - only DH 2048"
2406
2407 scripts/config.py full
2408
2409 # Disable all DH groups other than 2048.
2410 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2411 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2412 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2413 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2414
2415 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2416
2417 msg "test: full config - only DH 2048"
2418 make test
2419
2420 msg "ssl-opt: full config - only DH 2048"
2421 tests/ssl-opt.sh -f "ffdh"
2422}
2423
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002424component_build_no_pk_rsa_alt_support () {
2425 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2426
2427 scripts/config.py full
2428 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2429 scripts/config.py set MBEDTLS_RSA_C
2430 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2431
2432 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002433 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002434}
2435
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002436component_build_module_alt () {
2437 msg "build: MBEDTLS_XXX_ALT" # ~30s
2438 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002439
2440 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002441 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002442 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002443 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002444 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2445 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002446 # You can only have one threading implementation: alt or pthread, not both.
2447 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002448 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2449 # directly and assumes the implementation works with partial groups.
2450 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002451 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2452 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2453 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002454 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2455 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2456 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002457
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002458 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2459 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2460 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002461
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002462 # We can only compile, not link, since we don't have any implementations
2463 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002464 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002465}
2466
Gilles Peskine64996c32024-01-23 20:25:47 +01002467component_test_no_psa_crypto_full_cmake_asan() {
2468 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2469 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002470 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002471 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002472 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002473 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002474 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002475 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002476 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002477 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002478 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002479 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002480 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002481 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002482
Gilles Peskine64996c32024-01-23 20:25:47 +01002483 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002484 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002485
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002486 # Note: ssl-opt.sh has some test cases that depend on
2487 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2488 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002489 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002490 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002491
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002492 # Note: the next two invocations cover all compat.sh test cases.
2493 # We should use the same here and in basic-build-test.sh.
2494 msg "test: compat.sh: default version (full minus PSA crypto)"
2495 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002496
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002497 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002498 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002499}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002500
Ronald Cron403c15c2021-09-13 09:38:05 +02002501component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002502 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002503
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002504 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002505 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002506 $(helper_get_psa_key_type_list "ECC") \
2507 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002508
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002509 # Configure
2510 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002511
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002512 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002513 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002514
2515 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002516 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002517
2518 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002519 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2520 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2521
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002522 # Build
2523 # -----
2524
2525 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002526 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2527 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002528
2529 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2530
Valerio Setti3fe105b2023-10-30 11:08:12 +01002531 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002532
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002533 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002534 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002535
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002536 # Run the tests
2537 # -------------
2538
Ronald Cron403c15c2021-09-13 09:38:05 +02002539 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2540 make test
2541}
2542
Valerio Setti44b178c2023-03-22 14:02:57 +01002543component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002544 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002545
2546 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002547 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002548 $(helper_get_psa_key_type_list "ECC") \
2549 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002550
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002551 # Configure
2552 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002553
Ronald Cron46ac0652024-03-18 12:39:04 +01002554 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002555 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002556
Valerio Setti44b178c2023-03-22 14:02:57 +01002557 # Disable the module that's accelerated
2558 scripts/config.py unset MBEDTLS_ECDH_C
2559
2560 # Disable things that depend on it
2561 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2562 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2563 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2564 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2565 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2566
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002567 # Build
2568 # -----
2569
2570 helper_libtestdriver1_make_drivers "$loc_accel_list"
2571
Valerio Setti3fe105b2023-10-30 11:08:12 +01002572 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002573
Valerio Setti44b178c2023-03-22 14:02:57 +01002574 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002575 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002576
2577 # Run the tests
2578 # -------------
2579
Valerio Setti44b178c2023-03-22 14:02:57 +01002580 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002581 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002582}
2583
Przemek Stekieldccb2022023-05-11 10:48:50 +02002584component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002585 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002586
2587 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002588 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002589 $(helper_get_psa_key_type_list "DH") \
2590 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002591
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002592 # Configure
2593 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002594
Przemek Stekiel565353e2023-07-05 11:07:07 +02002595 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002596 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002597
2598 # Disable the module that's accelerated
2599 scripts/config.py unset MBEDTLS_DHM_C
2600
2601 # Disable things that depend on it
2602 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2603 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2604
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002605 # Build
2606 # -----
2607
2608 helper_libtestdriver1_make_drivers "$loc_accel_list"
2609
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002610 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002611
2612 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002613 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Przemek Stekieldccb2022023-05-11 10:48:50 +02002614
2615 # Run the tests
2616 # -------------
2617
Gilles Peskine14302ed2023-07-19 19:30:04 +02002618 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002619 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002620
Gilles Peskine14302ed2023-07-19 19:30:04 +02002621 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002622 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002623}
2624
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002625component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002626 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002627
2628 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002629 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002630
2631 # Disable things that are not supported
2632 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2633 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002634 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002635
Gilles Peskine14302ed2023-07-19 19:30:04 +02002636 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002637 make test
2638
Gilles Peskine14302ed2023-07-19 19:30:04 +02002639 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002640 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002641}
2642
Valerio Setti44b178c2023-03-22 14:02:57 +01002643component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002644 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002645
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002646 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002647 $(helper_get_psa_key_type_list "ECC") \
2648 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002649
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002650 # Configure
2651 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002652
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002653 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002654
2655 # Make built-in fallback not available
2656 scripts/config.py unset MBEDTLS_ECJPAKE_C
2657 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2658
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002659 # Build
2660 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002661
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002662 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002663
Valerio Setti3fe105b2023-10-30 11:08:12 +01002664 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002665
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002666 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002667 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002668
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002669 # Run the tests
2670 # -------------
2671
Gilles Peskine14302ed2023-07-19 19:30:04 +02002672 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002673 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002674}
2675
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002676component_test_psa_crypto_config_accel_ecc_some_key_types () {
2677 msg "build: full with accelerated EC algs and some key types"
2678
2679 # Algorithms and key types to accelerate
2680 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2681 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2682 ALG_ECDH \
2683 ALG_JPAKE \
2684 KEY_TYPE_ECC_PUBLIC_KEY \
2685 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2686 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002687 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2688 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002689
2690 # Configure
2691 # ---------
2692
2693 # start with config full for maximum coverage (also enables USE_PSA)
2694 helper_libtestdriver1_adjust_config "full"
2695
2696 # Disable modules that are accelerated - some will be re-enabled
2697 scripts/config.py unset MBEDTLS_ECDSA_C
2698 scripts/config.py unset MBEDTLS_ECDH_C
2699 scripts/config.py unset MBEDTLS_ECJPAKE_C
2700 scripts/config.py unset MBEDTLS_ECP_C
2701
2702 # Disable all curves - those that aren't accelerated should be re-enabled
2703 helper_disable_builtin_curves
2704
2705 # Restartable feature is not yet supported by PSA. Once it will in
2706 # the future, the following line could be removed (see issues
2707 # 6061, 6332 and following ones)
2708 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2709
2710 # this is not supported by the driver API yet
2711 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2712
2713 # Build
2714 # -----
2715
2716 # These hashes are needed for some ECDSA signature tests.
2717 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2718 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2719 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2720
Valerio Setti3fe105b2023-10-30 11:08:12 +01002721 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002722
2723 # ECP should be re-enabled but not the others
Ronald Cron709bbf02024-07-03 07:59:30 +02002724 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2725 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2726 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
2727 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002728
2729 # Run the tests
2730 # -------------
2731
2732 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002733 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002734}
2735
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002736# Run tests with only (non-)Weierstrass accelerated
2737# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002738# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2739# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002740common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002741 weierstrass=$1
2742 if [ $weierstrass -eq 1 ]; then
2743 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002744 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002745 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002746 fi
2747
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002748 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002749
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002750 # Note: Curves are handled in a special way by the libtestdriver machinery,
2751 # so we only want to include them in the accel list when building the main
2752 # libraries, hence the use of a separate variable.
2753 # Note: the following loop is a modified version of
2754 # helper_get_psa_curve_list that only keeps Weierstrass families.
2755 loc_weierstrass_list=""
2756 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002757 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2758 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002759 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002760 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002761 ;;
2762 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002763 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002764 ;;
2765 esac
2766 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002767 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002768 loc_curve_list=$loc_weierstrass_list
2769 else
2770 loc_curve_list=$loc_non_weierstrass_list
2771 fi
2772
Valerio Setti3fe105b2023-10-30 11:08:12 +01002773 # Algorithms and key types to accelerate
2774 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2775 ALG_ECDH \
2776 ALG_JPAKE \
2777 $(helper_get_psa_key_type_list "ECC") \
2778 $loc_curve_list"
2779
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002780 # Configure
2781 # ---------
2782
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002783 # Start with config crypto_full and remove PK_C:
2784 # that's what's supported now, see docs/driver-only-builds.md.
2785 helper_libtestdriver1_adjust_config "crypto_full"
2786 scripts/config.py unset MBEDTLS_PK_C
2787 scripts/config.py unset MBEDTLS_PK_PARSE_C
2788 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002789
2790 # Disable modules that are accelerated - some will be re-enabled
2791 scripts/config.py unset MBEDTLS_ECDSA_C
2792 scripts/config.py unset MBEDTLS_ECDH_C
2793 scripts/config.py unset MBEDTLS_ECJPAKE_C
2794 scripts/config.py unset MBEDTLS_ECP_C
2795
2796 # Disable all curves - those that aren't accelerated should be re-enabled
2797 helper_disable_builtin_curves
2798
2799 # Restartable feature is not yet supported by PSA. Once it will in
2800 # the future, the following line could be removed (see issues
2801 # 6061, 6332 and following ones)
2802 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2803
2804 # this is not supported by the driver API yet
2805 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2806
2807 # Build
2808 # -----
2809
2810 # These hashes are needed for some ECDSA signature tests.
2811 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2812 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2813 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2814
Valerio Settiac7a8092023-10-31 12:23:44 +01002815 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002816
2817 # We expect ECDH to be re-enabled for the missing curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002818 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002819 # We expect ECP to be re-enabled, however the parts specific to the
2820 # families of curves that are accelerated should be ommited.
2821 # - functions with mxz in the name are specific to Montgomery curves
2822 # - ecp_muladd is specific to Weierstrass curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002823 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002824 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002825 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2826 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002827 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002828 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2829 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002830 fi
2831 # We expect ECDSA and ECJPAKE to be re-enabled only when
2832 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002833 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002834 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2835 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002836 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002837 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2838 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002839 fi
2840
2841 # Run the tests
2842 # -------------
2843
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002844 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2845 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002846}
2847
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002848component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002849 common_test_psa_crypto_config_accel_ecc_some_curves 1
2850}
2851
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002852component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002853 common_test_psa_crypto_config_accel_ecc_some_curves 0
2854}
2855
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002856# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2857# ECDH, ECDSA) with and without drivers.
2858# The input parameter is a boolean value which indicates:
2859# - 0 keep built-in EC algs,
2860# - 1 exclude built-in EC algs (driver only).
2861#
2862# This is used by the two following components to ensure they always use the
2863# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002864# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2865# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002866# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002867config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002868 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002869 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002870 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002871 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002872 # Disable modules that are accelerated
2873 scripts/config.py unset MBEDTLS_ECDSA_C
2874 scripts/config.py unset MBEDTLS_ECDH_C
2875 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002876 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002877 fi
2878
2879 # Restartable feature is not yet supported by PSA. Once it will in
2880 # the future, the following line could be removed (see issues
2881 # 6061, 6332 and following ones)
2882 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002883}
2884
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002885# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2886component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002887 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002888
2889 # Algorithms and key types to accelerate
2890 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2891 ALG_ECDH \
2892 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002893 $(helper_get_psa_key_type_list "ECC") \
2894 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002895
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002896 # Configure
2897 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002898
2899 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002900 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002901
Valerio Setti0a342c92023-09-01 09:12:31 +02002902 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002903 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2904 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002905
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002906 # Build
2907 # -----
2908
2909 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002910 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2911 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002912 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2913
Valerio Setti3fe105b2023-10-30 11:08:12 +01002914 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002915
2916 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002917 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
2918 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2919 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
2920 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002921
2922 # Run the tests
2923 # -------------
2924
Gilles Peskine14302ed2023-07-19 19:30:04 +02002925 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002926 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002927
Gilles Peskine14302ed2023-07-19 19:30:04 +02002928 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002929 tests/ssl-opt.sh
2930}
2931
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002932# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2933component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002934 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002935
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002936 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002937
Gilles Peskine21570cf2023-12-22 11:49:50 +01002938 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002939
Gilles Peskine14302ed2023-07-19 19:30:04 +02002940 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002941 make test
2942
Gilles Peskine14302ed2023-07-19 19:30:04 +02002943 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002944 tests/ssl-opt.sh
2945}
2946
Valerio Settie618cb02023-04-12 14:59:16 +02002947# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002948# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2949# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002950# to ensure that both tests use the same underlying configuration when testing
2951# driver's coverage with analyze_outcomes.py.
2952#
2953# This functions accepts 1 boolean parameter as follows:
2954# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2955# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2956# - 0: include built-in implementation of EC algorithms.
2957#
2958# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2959# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002960config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002961 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002962 # start with full config for maximum coverage (also enables USE_PSA)
2963 helper_libtestdriver1_adjust_config "full"
2964
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002965 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002966 # Disable modules that are accelerated
2967 scripts/config.py unset MBEDTLS_ECDSA_C
2968 scripts/config.py unset MBEDTLS_ECDH_C
2969 scripts/config.py unset MBEDTLS_ECJPAKE_C
2970 # Disable ECP module (entirely)
2971 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002972 fi
2973
Valerio Settiaecd32c2023-06-14 10:42:31 +02002974 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2975 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002976 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002977 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002978
Valerio Settie618cb02023-04-12 14:59:16 +02002979 # Restartable feature is not yet supported by PSA. Once it will in
2980 # the future, the following line could be removed (see issues
2981 # 6061, 6332 and following ones)
2982 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002983}
2984
2985# Build and test a configuration where driver accelerates all EC algs while
2986# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2987# side.
2988#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002989# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2990component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002991 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002992
2993 # Algorithms and key types to accelerate
2994 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2995 ALG_ECDH \
2996 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002997 $(helper_get_psa_key_type_list "ECC") \
2998 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02002999
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003000 # Configure
3001 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003002
Valerio Settie618cb02023-04-12 14:59:16 +02003003 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003004 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003005 # Disable all the builtin curves. All the required algs are accelerated.
3006 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003007
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003008 # Build
3009 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003010
3011 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003012 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3013 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3014 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003015
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003016 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003017
Valerio Setti3fe105b2023-10-30 11:08:12 +01003018 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003019
3020 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003021 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3022 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3023 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003024 # Also ensure that ECP module was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003025 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003026
3027 # Run the tests
3028 # -------------
3029
Gilles Peskine14302ed2023-07-19 19:30:04 +02003030 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003031 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003032
Gilles Peskine14302ed2023-07-19 19:30:04 +02003033 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003034 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003035}
3036
3037# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003038# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003039# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003040component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003041 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003042
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003043 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003044
Gilles Peskine21570cf2023-12-22 11:49:50 +01003045 make
Valerio Settie618cb02023-04-12 14:59:16 +02003046
Gilles Peskine14302ed2023-07-19 19:30:04 +02003047 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003048 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003049
Gilles Peskine14302ed2023-07-19 19:30:04 +02003050 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003051 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003052}
3053
Valerio Setti4e2f2442023-08-15 10:10:26 +02003054# This is a common configuration helper used directly from:
3055# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3056# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3057# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003058# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003059# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003060# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003061# - this is the reference component of the above
3062# - it still disables RSA and FFDH, but it uses builtin EC algs
3063# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3064# - accelerate all EC and FFDH algs, disable only RSA
3065# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3066# - this is the reference component of the above
3067# - it still disables RSA, but it uses builtin EC and FFDH algs
3068#
3069# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003070# $1: a boolean value which states if we are testing an accelerated scenario
3071# or not.
3072# $2: a string value which states which components are tested. Allowed values
3073# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003074config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003075 driver_only="$1"
3076 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003077 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003078 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003079
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003080 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003081 # Disable modules that are accelerated
3082 scripts/config.py unset MBEDTLS_ECDSA_C
3083 scripts/config.py unset MBEDTLS_ECDH_C
3084 scripts/config.py unset MBEDTLS_ECJPAKE_C
3085 # Disable ECP module (entirely)
3086 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003087 # Also disable bignum
3088 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003089 fi
3090
3091 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3092 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3093 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3094 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3095
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003096 # RSA support is intentionally disabled on this test because RSA_C depends
3097 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003098 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3099 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 +02003100 scripts/config.py unset MBEDTLS_RSA_C
3101 scripts/config.py unset MBEDTLS_PKCS1_V15
3102 scripts/config.py unset MBEDTLS_PKCS1_V21
3103 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3104 # Also disable key exchanges that depend on RSA
3105 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3106 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3107 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3108 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3109 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3110
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003111 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003112 # When testing ECC only, we disable FFDH support, both from builtin and
3113 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003114 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003115 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 +01003116 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003117 scripts/config.py unset MBEDTLS_DHM_C
3118 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3119 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3120 else
3121 # When testing ECC and DH instead, we disable DHM and depending key
3122 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003123 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003124 scripts/config.py unset MBEDTLS_DHM_C
3125 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3126 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3127 fi
3128 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003129
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003130 # Restartable feature is not yet supported by PSA. Once it will in
3131 # the future, the following line could be removed (see issues
3132 # 6061, 6332 and following ones)
3133 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3134}
3135
Valerio Setti4e2f2442023-08-15 10:10:26 +02003136# Common helper used by:
3137# - component_test_psa_crypto_config_accel_ecc_no_bignum
3138# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003139#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003140# The goal is to build and test accelerating either:
3141# - ECC only or
3142# - both ECC and FFDH
3143#
3144# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003145# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3146# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003147common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003148 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003149
Valerio Setti5dfaca42023-09-05 08:48:51 +02003150 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003151 if [ "$test_target" = "ECC_DH" ]; then
3152 accel_text="ECC/FFDH"
3153 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003154 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003155 accel_text="ECC"
3156 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003157 fi
3158
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003159 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003160
3161 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003162 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3163 ALG_ECDH \
3164 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003165 $(helper_get_psa_key_type_list "ECC") \
3166 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003167 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003168 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003169 loc_accel_list="$loc_accel_list \
3170 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003171 $(helper_get_psa_key_type_list "DH") \
3172 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003173 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003174
3175 # Configure
3176 # ---------
3177
3178 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003179 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003180 # Disable all the builtin curves. All the required algs are accelerated.
3181 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003182
3183 # Build
3184 # -----
3185
3186 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003187 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3188 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3189 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003190
3191 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3192
Valerio Setti3fe105b2023-10-30 11:08:12 +01003193 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003194
3195 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003196 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3197 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3198 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003199 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003200 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3201 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3202 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
3203 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003204
3205 # Run the tests
3206 # -------------
3207
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003208 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003209
Gilles Peskine21570cf2023-12-22 11:49:50 +01003210 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003211
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003212 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003213 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003214}
3215
Valerio Setti4e2f2442023-08-15 10:10:26 +02003216# Common helper used by:
3217# - component_test_psa_crypto_config_reference_ecc_no_bignum
3218# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3219#
3220# The goal is to build and test a reference scenario (i.e. with builtin
3221# components) compared to the ones used in
3222# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3223#
3224# It is meant to be used in conjunction with
3225# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3226# coverage analysis in "analyze_outcomes.py" script.
3227common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003228 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003229
Valerio Setti5dfaca42023-09-05 08:48:51 +02003230 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003231 if [ "$test_target" = "ECC_DH" ]; then
3232 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003233 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003234 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003235 fi
3236
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003237 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003238
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003239 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003240
Gilles Peskine21570cf2023-12-22 11:49:50 +01003241 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003242
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003243 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003244 make test
3245
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003246 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003247 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003248}
3249
Valerio Setti4e2f2442023-08-15 10:10:26 +02003250component_test_psa_crypto_config_accel_ecc_no_bignum () {
3251 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3252}
3253
3254component_test_psa_crypto_config_reference_ecc_no_bignum () {
3255 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3256}
3257
3258component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3259 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3260}
3261
3262component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3263 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3264}
3265
Valerio Settiac6d35f2023-08-04 12:49:11 +02003266# Helper for setting common configurations between:
3267# - component_test_tfm_config_p256m_driver_accel_ec()
3268# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003269common_tfm_config () {
3270 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003271 cp configs/config-tfm.h "$CONFIG_H"
3272 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3273 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003274
Yanray Wang73bb2312023-09-25 11:21:15 +08003275 # Other config adjustment to make the tests pass.
3276 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003277 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003278 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3279 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003280
Yanray Wang73bb2312023-09-25 11:21:15 +08003281 # Config adjustment for better test coverage in our environment.
3282 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003283 #
3284 # Enable filesystem I/O for the benefit of PK parse/write tests.
3285 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3286}
3287
Valerio Settiac6d35f2023-08-04 12:49:11 +02003288# Keep this in sync with component_test_tfm_config() as they are both meant
3289# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003290component_test_tfm_config_p256m_driver_accel_ec () {
3291 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3292
3293 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003294
Dave Rodgman897bb772023-11-15 16:34:20 +00003295 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003296 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003297
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003298 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003299 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3300 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3301 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib7e95442023-03-21 11:52:33 +01003302 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003303 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3304 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3305 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
3306 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003307 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003308 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003309
Valerio Setti5e18b902023-12-04 12:07:30 +01003310 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3311 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003312 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003313
Valerio Settib7e95442023-03-21 11:52:33 +01003314 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003315 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003316 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003317}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003318
Valerio Settiac6d35f2023-08-04 12:49:11 +02003319# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3320# they are both meant to be used in analyze_outcomes.py for driver's coverage
3321# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003322component_test_tfm_config() {
3323 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003324
Dave Rodgman897bb772023-11-15 16:34:20 +00003325 # Disable P256M driver, which is on by default, so that analyze_outcomes
3326 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3327 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3328
Valerio Setti52ba0e32023-08-04 12:43:03 +02003329 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003330 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003331
Dave Rodgman897bb772023-11-15 16:34:20 +00003332 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003333 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003334
Valerio Setti5e18b902023-12-04 12:07:30 +01003335 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3336 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003337 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003338
Valerio Setti52ba0e32023-08-04 12:43:03 +02003339 msg "test: TF-M config"
3340 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003341}
3342
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003343# Common helper for component_full_without_ecdhe_ecdsa() and
3344# component_full_without_ecdhe_ecdsa_and_tls13() which:
3345# - starts from the "full" configuration minus the list of symbols passed in
3346# as 1st parameter
3347# - build
3348# - test only TLS (i.e. test_suite_tls and ssl-opt)
3349build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003350 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003351
3352 msg "build: full minus something, test TLS"
3353
3354 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003355 for sym in $symbols_to_disable; do
3356 echo "Disabling $sym"
3357 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003358 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003359
Gilles Peskine21570cf2023-12-22 11:49:50 +01003360 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003361
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003362 msg "test: full minus something, test TLS"
3363 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003364
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003365 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003366 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003367}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003368
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003369component_full_without_ecdhe_ecdsa () {
3370 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003371}
3372
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003373component_full_without_ecdhe_ecdsa_and_tls13 () {
3374 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3375 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003376}
3377
Valerio Setti249b18a2023-06-20 12:08:30 +02003378# This is an helper used by:
3379# - component_test_psa_ecc_key_pair_no_derive
3380# - component_test_psa_ecc_key_pair_no_generate
3381# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3382# enabled, but one. Input arguments are as follows:
3383# - $1 is the key type under test, i.e. ECC/RSA/DH
3384# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003385build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003386 key_type=$1
3387 unset_option=$2
3388 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003389
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003390 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003391 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003392 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3393 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3394
3395 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3396 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003397 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003398
Gilles Peskine21570cf2023-12-22 11:49:50 +01003399 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003400
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003401 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003402 make test
3403}
3404
3405component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003406 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003407}
3408
3409component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003410 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003411}
3412
Pengyu Lve705f572023-12-06 16:38:15 +08003413config_psa_crypto_accel_rsa () {
3414 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003415
Pengyu Lve705f572023-12-06 16:38:15 +08003416 # Start from crypto_full config (no X.509, no TLS)
3417 helper_libtestdriver1_adjust_config "crypto_full"
3418
3419 if [ "$driver_only" -eq 1 ]; then
3420 # Remove RSA support and its dependencies
3421 scripts/config.py unset MBEDTLS_RSA_C
3422 scripts/config.py unset MBEDTLS_PKCS1_V15
3423 scripts/config.py unset MBEDTLS_PKCS1_V21
3424
3425 # We need PEM parsing in the test library as well to support the import
3426 # of PEM encoded RSA keys.
3427 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3428 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3429 fi
3430}
3431
3432component_test_psa_crypto_config_accel_rsa_crypto () {
3433 msg "build: crypto_full with accelerated RSA"
3434
3435 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3436 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3437 KEY_TYPE_RSA_PUBLIC_KEY \
3438 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3439 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3440 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3441 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003442
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003443 # Configure
3444 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003445
Pengyu Lve705f572023-12-06 16:38:15 +08003446 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003447
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003448 # Build
3449 # -----
3450
Pengyu Lve705f572023-12-06 16:38:15 +08003451 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003452 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 +08003453 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003454 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003455
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003456 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003457
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003458 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003459 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003460
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003461 # Run the tests
3462 # -------------
3463
Pengyu Lve705f572023-12-06 16:38:15 +08003464 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003465 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003466}
3467
3468component_test_psa_crypto_config_reference_rsa_crypto () {
3469 msg "build: crypto_full with non-accelerated RSA"
3470
3471 # Configure
3472 # ---------
3473 config_psa_crypto_accel_rsa 0
3474
3475 # Build
3476 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003477 make
Pengyu Lve705f572023-12-06 16:38:15 +08003478
3479 # Run the tests
3480 # -------------
3481 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003482 make test
3483}
3484
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003485# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003486# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003487component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003488 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003489
Valerio Setti4590bc22023-06-13 15:39:23 +02003490 # Create a temporary output file unless there is already one set
3491 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3492 REMOVE_OUTCOME_ON_EXIT="no"
3493 else
3494 REMOVE_OUTCOME_ON_EXIT="yes"
3495 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3496 export MBEDTLS_TEST_OUTCOME_FILE
3497 fi
3498
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003499 # Start from crypto configuration
3500 scripts/config.py crypto
3501
3502 # Remove RSA support and its dependencies
3503 scripts/config.py unset MBEDTLS_PKCS1_V15
3504 scripts/config.py unset MBEDTLS_PKCS1_V21
3505 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3506 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3507 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3508 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3509 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3510 scripts/config.py unset MBEDTLS_RSA_C
3511 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3512
3513 # Enable PSA support
3514 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3515
Valerio Setti01cc88a2023-06-15 11:53:08 +02003516 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003517 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003518 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3519 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3520 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003521
3522 make
3523
Valerio Setti01cc88a2023-06-15 11:53:08 +02003524 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003525 make test
3526
3527 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3528 # performing RSA signature.
3529 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3530 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3531
3532 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3533 rm $MBEDTLS_TEST_OUTCOME_FILE
3534 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003535}
3536
Ronald Cronb2312452021-05-08 14:32:59 +02003537component_test_psa_crypto_config_accel_hash () {
3538 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3539
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003540 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3541 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3542 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003543
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003544 # Configure
3545 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003546
Ronald Cron46ac0652024-03-18 12:39:04 +01003547 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003548 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003549
3550 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003551 scripts/config.py unset MBEDTLS_MD5_C
3552 scripts/config.py unset MBEDTLS_RIPEMD160_C
3553 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003554 scripts/config.py unset MBEDTLS_SHA224_C
3555 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003556 scripts/config.py unset MBEDTLS_SHA384_C
3557 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003558 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003559
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003560 # Build
3561 # -----
3562
3563 helper_libtestdriver1_make_drivers "$loc_accel_list"
3564
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003565 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003566
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003567 # There's a risk of something getting re-enabled via config_psa.h;
3568 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003569 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3570 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3571 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3572 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3573 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003574
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003575 # Run the tests
3576 # -------------
3577
Ronald Cronb2312452021-05-08 14:32:59 +02003578 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3579 make test
3580}
3581
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003582# Auxiliary function to build config for hashes with and without drivers
3583config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003584 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003585 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003586 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003587 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003588 # disable the built-in implementation of hashes
3589 scripts/config.py unset MBEDTLS_MD5_C
3590 scripts/config.py unset MBEDTLS_RIPEMD160_C
3591 scripts/config.py unset MBEDTLS_SHA1_C
3592 scripts/config.py unset MBEDTLS_SHA224_C
3593 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003594 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003595 scripts/config.py unset MBEDTLS_SHA384_C
3596 scripts/config.py unset MBEDTLS_SHA512_C
3597 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003598 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003599 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003600}
3601
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003602# Note that component_test_psa_crypto_config_reference_hash_use_psa
3603# is related to this component and both components need to be kept in sync.
3604# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003605component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003606 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003607
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003608 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3609 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3610 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003611
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003612 # Configure
3613 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003614
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003615 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003616
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003617 # Build
3618 # -----
3619
3620 helper_libtestdriver1_make_drivers "$loc_accel_list"
3621
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003622 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003623
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003624 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003625 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003626 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3627 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3628 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3629 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3630 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003631
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003632 # Run the tests
3633 # -------------
3634
Gilles Peskine14302ed2023-07-19 19:30:04 +02003635 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003636 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003637
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003638 # This is mostly useful so that we can later compare outcome files with
3639 # the reference config in analyze_outcomes.py, to check that the
3640 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003641 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003642 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003643
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003644 # This is to make sure all ciphersuites are exercised, but we don't need
3645 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003646 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003647 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003648}
3649
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003650# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3651# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3652# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3653# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003654component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003655 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003656
3657 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003658
Gilles Peskine21570cf2023-12-22 11:49:50 +01003659 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003660
Gilles Peskine14302ed2023-07-19 19:30:04 +02003661 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003662 make test
3663
Gilles Peskine14302ed2023-07-19 19:30:04 +02003664 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003665 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003666}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003667
Valerio Setti8eb310c2024-01-22 16:22:57 +01003668# Auxiliary function to build config for hashes with and without drivers
3669config_psa_crypto_hmac_use_psa () {
3670 driver_only="$1"
3671 # start with config full for maximum coverage (also enables USE_PSA)
3672 helper_libtestdriver1_adjust_config "full"
3673
Valerio Setticd89b0b2024-01-24 14:24:55 +01003674 if [ "$driver_only" -eq 1 ]; then
3675 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3676 # is still enabled though (for ENTROPY_C among others).
3677 scripts/config.py unset MBEDTLS_MD_C
3678 # Disable also the builtin hashes since they are supported by the driver
3679 # and MD module is able to perform PSA dispathing.
3680 scripts/config.py unset-all MBEDTLS_SHA
3681 scripts/config.py unset MBEDTLS_MD5_C
3682 scripts/config.py unset MBEDTLS_RIPEMD160_C
3683 fi
3684
Valerio Setti8eb310c2024-01-22 16:22:57 +01003685 # Direct dependencies of MD_C. We disable them also in the reference
3686 # component to work with the same set of features.
3687 scripts/config.py unset MBEDTLS_PKCS7_C
3688 scripts/config.py unset MBEDTLS_PKCS5_C
3689 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3690 scripts/config.py unset MBEDTLS_HKDF_C
3691 # Dependencies of HMAC_DRBG
3692 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3693 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3694}
3695
3696component_test_psa_crypto_config_accel_hmac() {
3697 msg "test: full with accelerated hmac"
3698
3699 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3700 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3701 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3702 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3703
3704 # Configure
3705 # ---------
3706
3707 config_psa_crypto_hmac_use_psa 1
3708
Valerio Setti8eb310c2024-01-22 16:22:57 +01003709 # Build
3710 # -----
3711
3712 helper_libtestdriver1_make_drivers "$loc_accel_list"
3713
3714 helper_libtestdriver1_make_main "$loc_accel_list"
3715
3716 # Ensure that built-in support for HMAC is disabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003717 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
Valerio Setti8eb310c2024-01-22 16:22:57 +01003718
3719 # Run the tests
3720 # -------------
3721
3722 msg "test: full with accelerated hmac"
3723 make test
3724}
3725
3726component_test_psa_crypto_config_reference_hmac() {
3727 msg "test: full without accelerated hmac"
3728
3729 config_psa_crypto_hmac_use_psa 0
3730
3731 make
3732
3733 msg "test: full without accelerated hmac"
3734 make test
3735}
3736
Valerio Setti9da01a72023-12-18 17:38:18 +01003737component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003738 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003739
Valerio Setti9da01a72023-12-18 17:38:18 +01003740 # Albeit this components aims at accelerating DES which should only support
3741 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3742 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003743 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3744 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3745 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003746
Valerio Setti9da01a72023-12-18 17:38:18 +01003747 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3748 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3749 # of this component. This limitation will be addressed by #8598.
3750
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003751 # Configure
3752 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003753
Valerio Setti9a427302023-10-17 11:40:42 +02003754 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003755 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003756
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003757 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003758 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3759 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3760 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3761 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3762 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3763 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3764 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003765 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003766
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003767 # Build
3768 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003769
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003770 helper_libtestdriver1_make_drivers "$loc_accel_list"
3771
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003772 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003773
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003774 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003775 not grep mbedtls_des* ${BUILTIN_SRC_PATH}/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003776
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003777 # Run the tests
3778 # -------------
3779
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003780 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003781 make test
3782}
3783
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003784component_test_psa_crypto_config_accel_aead () {
3785 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3786
Valerio Setti3f02bb72023-10-02 15:57:33 +02003787 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3788 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003789
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003790 # Configure
3791 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003792
Valerio Setti3f02bb72023-10-02 15:57:33 +02003793 # Start from full config
3794 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003795
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003796 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003797 scripts/config.py unset MBEDTLS_GCM_C
3798 scripts/config.py unset MBEDTLS_CCM_C
3799 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003800
Valerio Settia50b89e2023-11-08 15:58:47 +01003801 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3802 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003803
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003804 # Build
3805 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003806
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003807 helper_libtestdriver1_make_drivers "$loc_accel_list"
3808
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003809 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003810
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003811 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003812 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3813 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3814 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
Przemek Stekielee1bb412022-10-11 11:52:25 +02003815
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003816 # Run the tests
3817 # -------------
3818
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003819 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3820 make test
3821}
3822
Valerio Settib680fc42023-10-13 09:29:37 +02003823# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003824# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3825# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3826common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003827 # Start from the full config
3828 helper_libtestdriver1_adjust_config "full"
3829
Valerio Settib680fc42023-10-13 09:29:37 +02003830 scripts/config.py unset MBEDTLS_NIST_KW_C
3831}
3832
Valerio Settib6b301f2023-10-04 12:05:05 +02003833# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003834# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3835# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003836# are meant to be used together in analyze_outcomes.py script in order to test
3837# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003838component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3839 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003840
Valerio Settiad8b7f02023-10-25 12:39:50 +02003841 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 +01003842 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003843 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003844 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3845
3846 # Configure
3847 # ---------
3848
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003849 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003850
3851 # Disable the things that are being accelerated
3852 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3853 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3854 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3855 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3856 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3857 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3858 scripts/config.py unset MBEDTLS_GCM_C
3859 scripts/config.py unset MBEDTLS_CCM_C
3860 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003861 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003862 scripts/config.py unset MBEDTLS_DES_C
3863 scripts/config.py unset MBEDTLS_AES_C
3864 scripts/config.py unset MBEDTLS_ARIA_C
3865 scripts/config.py unset MBEDTLS_CHACHA20_C
3866 scripts/config.py unset MBEDTLS_CAMELLIA_C
3867
Valerio Settiec9b2582023-11-08 16:50:54 +01003868 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3869 # does not depend on it.
3870 scripts/config.py unset MBEDTLS_CIPHER_C
3871
Valerio Settib6b301f2023-10-04 12:05:05 +02003872 # Build
3873 # -----
3874
3875 helper_libtestdriver1_make_drivers "$loc_accel_list"
3876
3877 helper_libtestdriver1_make_main "$loc_accel_list"
3878
3879 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003880 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
3881 not grep mbedtls_des ${BUILTIN_SRC_PATH}/des.o
3882 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
3883 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
3884 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
3885 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3886 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3887 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
3888 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003889
3890 # Run the tests
3891 # -------------
3892
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003893 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003894 make test
Valerio Settif9414552023-11-09 10:43:20 +01003895
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003896 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003897 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003898
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003899 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003900 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003901}
3902
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003903component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3904 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3905 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003906
Gilles Peskine21570cf2023-12-22 11:49:50 +01003907 make
Valerio Settif9414552023-11-09 10:43:20 +01003908
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003909 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003910 make test
Valerio Settif9414552023-11-09 10:43:20 +01003911
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003912 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003913 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003914
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003915 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003916 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003917}
3918
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003919common_block_cipher_dispatch() {
3920 TEST_WITH_DRIVER="$1"
3921
3922 # Start from the full config
3923 helper_libtestdriver1_adjust_config "full"
3924
3925 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3926 # Disable key types that are accelerated (there is no legacy equivalent
3927 # symbol for ECB)
3928 scripts/config.py unset MBEDTLS_AES_C
3929 scripts/config.py unset MBEDTLS_ARIA_C
3930 scripts/config.py unset MBEDTLS_CAMELLIA_C
3931 fi
3932
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003933 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003934 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003935 # Keep this also in the reference component in order to skip the same tests
3936 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003937 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
3938 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
3939 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
3940 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
3941 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
3942 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
3943 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02003944 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003945
3946 # Disable direct dependency on AES_C
3947 scripts/config.py unset MBEDTLS_NIST_KW_C
3948
3949 # Prevent the cipher module from using deprecated PSA path. The reason is
3950 # that otherwise there will be tests relying on "aes_info" (defined in
3951 # "cipher_wrap.c") whose functions are not available when AES_C is
3952 # not defined. ARIA and Camellia are not a problem in this case because
3953 # the PSA path is not tested for these key types.
3954 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
3955}
3956
Valerio Settif8e6cba2023-12-12 11:53:39 +01003957component_test_full_block_cipher_psa_dispatch () {
3958 msg "build: full + PSA dispatch in block_cipher"
3959
3960 loc_accel_list="ALG_ECB_NO_PADDING \
3961 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
3962
3963 # Configure
3964 # ---------
3965
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003966 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01003967
Valerio Settif8e6cba2023-12-12 11:53:39 +01003968 # Build
3969 # -----
3970
3971 helper_libtestdriver1_make_drivers "$loc_accel_list"
3972
3973 helper_libtestdriver1_make_main "$loc_accel_list"
3974
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003975 # Make sure disabled components were not re-enabled by accident (additive
3976 # config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003977 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
3978 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
3979 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003980
Valerio Settif8e6cba2023-12-12 11:53:39 +01003981 # Run the tests
3982 # -------------
3983
3984 msg "test: full + PSA dispatch in block_cipher"
3985 make test
3986}
3987
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003988# This is the reference component of component_test_full_block_cipher_psa_dispatch
3989component_test_full_block_cipher_legacy_dispatch () {
3990 msg "build: full + legacy dispatch in block_cipher"
3991
3992 common_block_cipher_dispatch 0
3993
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003994 make
3995
3996 msg "test: full + legacy dispatch in block_cipher"
3997 make test
3998}
3999
Gilles Peskine36dea152023-07-20 22:19:45 +02004000component_test_aead_chachapoly_disabled() {
4001 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004002 scripts/config.py full
4003 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004004 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004005 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004006
Gilles Peskine36dea152023-07-20 22:19:45 +02004007 msg "test: full minus CHACHAPOLY"
4008 make test
4009}
4010
4011component_test_aead_only_ccm() {
4012 msg "build: full minus CHACHAPOLY and GCM"
4013 scripts/config.py full
4014 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4015 scripts/config.py unset MBEDTLS_GCM_C
4016 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4017 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004018 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004019
4020 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004021 make test
4022}
4023
Ronald Crone501d0e2023-07-10 08:31:19 +02004024component_test_ccm_aes_sha256() {
4025 msg "build: CCM + AES + SHA256 configuration"
4026
Ronald Cron7612d8c2023-07-20 10:03:54 +02004027 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004028 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004029
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004030 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004031
4032 msg "test: CCM + AES + SHA256 configuration"
4033 make test
4034}
4035
Dave Rodgman904c5892023-06-28 17:36:02 +01004036support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004037 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004038}
4039
Dave Rodgman904c5892023-06-28 17:36:02 +01004040component_build_tfm_armcc() {
4041 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004042 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004043
Dave Rodgman88651c42023-06-29 12:35:51 +01004044 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004045 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 +01004046}
4047
4048component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004049 # Check that the TF-M configuration can build cleanly with various
4050 # warning flags enabled. We don't build or run tests, since the
4051 # TF-M configuration needs a TF-M platform. A tweaked version of
4052 # the configuration that works on mainstream platforms is in
4053 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004054 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004055
Dave Rodgman88651c42023-06-29 12:35:51 +01004056 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004057 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 +01004058
Dave Rodgman904c5892023-06-28 17:36:02 +01004059 msg "build: TF-M config, gcc native build"
4060 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004061 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 +01004062}
4063
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004064# Test that the given .o file builds with all (valid) combinations of the given options.
4065#
4066# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4067#
4068# The validator function is the name of a function to validate the combination of options.
4069# It may be "" if all combinations are valid.
4070# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004071# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004072build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004073 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004074 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004075 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004076 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004077 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004078
Dave Rodgman42436102023-10-03 15:47:05 +01004079 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004080 for opt in "${options[@]}"; do
4081 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004082 done
4083
Ronald Cron709bbf02024-07-03 07:59:30 +02004084 # enter the library directory
4085 cd library
Dave Rodgman42436102023-10-03 15:47:05 +01004086
Dave Rodgman920343a2023-10-01 18:41:09 +01004087 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004088 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 +01004089
Dave Rodgman42436102023-10-03 15:47:05 +01004090 # Extract the command generated by the Makefile to build the target file.
4091 # This ensures that we have any include paths, macro definitions, etc
4092 # that may be applied by make.
4093 # 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 +01004094 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004095
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004096 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004097 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004098
Dave Rodgman28e38d82023-10-04 11:50:30 +01004099 len=${#options[@]}
Ronald Cron709bbf02024-07-03 07:59:30 +02004100 source_file=../${file%.o}.c
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004101
4102 targets=0
4103 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004104
Dave Rodgman28e38d82023-10-04 11:50:30 +01004105 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004106 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004107 # each bit of $i is used to determine if options[i] will be set or not
4108 target="t"
4109 clang_args=""
4110 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004111 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004112 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004113 clang_args="${clang_args} ${opt}"
4114 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004115 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004116 done
4117
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004118 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004119 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004120 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004121 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004122
Dave Rodgman28e38d82023-10-04 11:50:30 +01004123 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004124 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004125 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004126 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004127
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004128 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004129
Dave Rodgman920343a2023-10-01 18:41:09 +01004130 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004131 make -s -f ${makefile} build_test_config_combos
4132 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004133
4134 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004135 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004136}
4137
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004138validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004139 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004140 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4141 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004142 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004143 fi
4144 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004145 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004146}
4147
4148component_build_aes_variations() {
4149 # 18s - around 90ms per clang invocation on M1 Pro
4150 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004151 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004152 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004153
Yanray Wangbc29aef2023-11-06 11:08:17 +08004154 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004155 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004156
Ronald Cron709bbf02024-07-03 07:59:30 +02004157 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004158 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4159 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004160 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004161 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004162
4163 cd "$MBEDTLS_ROOT_DIR"
4164 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4165
Yanray Wang42be1ba2023-11-23 14:28:47 +08004166 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004167 # manually set or unset those configurations to check
4168 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004169 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4170 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4171 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4172 scripts/config.py unset MBEDTLS_DES_C
4173 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron709bbf02024-07-03 07:59:30 +02004174 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004175 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4176 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004177 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004178 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004179}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004180
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004181component_test_no_platform () {
4182 # Full configuration build, without platform support, file IO and net sockets.
4183 # This should catch missing mbedtls_printf definitions, and by disabling file
4184 # IO, it should catch missing '#include <stdio.h>'
4185 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004186 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004187 scripts/config.py unset MBEDTLS_PLATFORM_C
4188 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004189 scripts/config.py unset MBEDTLS_FS_IO
4190 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004191 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004192 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004193 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004194 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004195 # to re-enable platform integration features otherwise disabled in C99 builds
4196 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004197 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004198}
Gilles Peskine7c652162017-12-11 00:01:40 +01004199
4200component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004201 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004202 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4203 scripts/config.py full
4204 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004205 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4206 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4207 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4208 make
4209}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004210
Gilles Peskine8f073122018-11-27 15:58:47 +01004211component_build_no_ssl_srv () {
4212 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004213 scripts/config.py full
4214 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004215 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004216}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004217
Gilles Peskine8f073122018-11-27 15:58:47 +01004218component_build_no_ssl_cli () {
4219 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004220 scripts/config.py full
4221 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004222 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004223}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004224
Gilles Peskine8f073122018-11-27 15:58:47 +01004225component_build_no_sockets () {
4226 # Note, C99 compliance can also be tested with the sockets support disabled,
4227 # as that requires a POSIX platform (which isn't the same as C99).
4228 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004229 scripts/config.py full
4230 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4231 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4232 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4233}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004234
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004235component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004236 msg "build: default config with memory buffer allocator and backtrace enabled"
4237 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4238 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4239 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004240 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004241 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004242 make
4243
4244 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4245 make test
4246}
4247
4248component_test_memory_buffer_allocator () {
4249 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004250 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4251 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004252 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004253 make
4254
4255 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4256 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004257
4258 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4259 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004260 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004261}
4262
Gilles Peskine8f073122018-11-27 15:58:47 +01004263component_test_no_max_fragment_length () {
4264 # Run max fragment length tests with MFL disabled
4265 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004266 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004267 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004268 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004269
Gilles Peskine8f073122018-11-27 15:58:47 +01004270 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004271 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004272}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004273
Hanno Becker545ced42019-02-19 11:10:48 +00004274component_test_asan_remove_peer_certificate () {
4275 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004276 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004277 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004278 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004279 make
4280
4281 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4282 make test
4283
4284 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004285 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004286
4287 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004288 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004289
4290 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004291 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004292}
4293
Gilles Peskine8f073122018-11-27 15:58:47 +01004294component_test_no_max_fragment_length_small_ssl_out_content_len () {
4295 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004296 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4297 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4298 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004299 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004300 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004301
Gilles Peskine8f073122018-11-27 15:58:47 +01004302 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004303 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004304
4305 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004306 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004307}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004308
Darryl Greenaad82f92019-12-02 10:53:11 +00004309component_test_variable_ssl_in_out_buffer_len () {
4310 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4311 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004312 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004313 make
4314
4315 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4316 make test
4317
4318 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004319 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004320
4321 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004322 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004323}
4324
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004325component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004326 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004327 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004328
Dave Rodgman17127e92023-12-14 16:42:48 +00004329 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004330 make
4331
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004332 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004333 make test
4334
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004335 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004336 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004337
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004338 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004339 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004340}
4341
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004342component_test_ssl_alloc_buffer_and_mfl () {
4343 msg "build: default config with memory buffer allocator and MFL extension"
4344 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4345 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4346 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4347 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4348 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004349 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004350 make
4351
4352 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4353 make test
4354
4355 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 +02004356 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004357}
4358
Gilles Peskine636c26a2020-03-04 20:46:15 +01004359component_test_when_no_ciphersuites_have_mac () {
4360 msg "build: when no ciphersuites have MAC"
Ronald Cron0417a2c2024-05-24 14:22:11 +02004361 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4362 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4363 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4364 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4365 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
4366
Gilles Peskine636c26a2020-03-04 20:46:15 +01004367 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004368 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004369 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron0417a2c2024-05-24 14:22:11 +02004370
Gilles Peskine636c26a2020-03-04 20:46:15 +01004371 make
4372
Ronald Croncd33cd62024-05-27 08:14:27 +02004373 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004374 make test
4375
Ronald Croncd33cd62024-05-27 08:14:27 +02004376 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004377 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004378}
4379
Raoul Strackxa4e86142020-06-15 17:03:13 +02004380component_test_no_date_time () {
4381 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4382 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004383 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004384 make
4385
4386 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4387 make test
4388}
4389
Gilles Peskine8f073122018-11-27 15:58:47 +01004390component_test_platform_calloc_macro () {
4391 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004392 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4393 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4394 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004395 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004396 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004397
Gilles Peskine8f073122018-11-27 15:58:47 +01004398 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4399 make test
4400}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004401
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004402component_test_malloc_0_null () {
4403 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004404 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004405 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 +02004406
4407 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4408 make test
4409
4410 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4411 # Just the calloc selftest. "make test" ran the others as part of the
4412 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004413 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004414
4415 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4416 # Run a subset of the tests. The choice is a balance between coverage
4417 # and time (including time indirectly wasted due to flaky tests).
4418 # The current choice is to skip tests whose description includes
4419 # "proxy", which is an approximation of skipping tests that use the
4420 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004421 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004422}
4423
Dave Rodgman6a08b682023-06-19 11:51:33 +01004424support_test_aesni() {
4425 # Check that gcc targets x86_64 (we can build AESNI), and check for
4426 # AESNI support on the host (we can run AESNI).
4427 #
4428 # The name of this function is possibly slightly misleading, but needs to align
4429 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004430 #
4431 # In principle 32-bit x86 can support AESNI, but our implementation does not
4432 # support 32-bit x86, so we check for x86-64.
4433 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004434 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4435 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004436 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004437}
4438
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004439component_test_aesni () { # ~ 60s
4440 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4441 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4442 #
4443 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4444 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4445 # exercise the plain C impl).
4446
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004447 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004448 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004449 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004450 scripts/config.py set MBEDTLS_HAVE_ASM
4451
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004452 # test the intrinsics implementation
4453 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004454 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004455 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004456 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004457 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004458
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004459 # test the asm implementation
4460 msg "AES tests, test assembly"
4461 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004462 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004463 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004464 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004465
4466 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004467 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004468 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004469 msg "AES tests, plain C"
4470 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004471 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004472 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004473 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004474 not grep -q "AES note: using AESNI" ./programs/test/selftest
4475 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004476
4477 # test the intrinsics implementation
4478 scripts/config.py set MBEDTLS_AESNI_C
4479 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4480 msg "AES tests, test AESNI only"
4481 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004482 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004483 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4484 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004485 grep -q "AES note: using AESNI" ./programs/test/selftest
4486 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004487}
4488
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004489component_test_sha3_variations() {
4490 msg "sha3 loop unroll variations"
4491
4492 # define minimal config sufficient to test SHA3
4493 cat > include/mbedtls/mbedtls_config.h << END
4494 #define MBEDTLS_SELF_TEST
4495 #define MBEDTLS_SHA3_C
4496END
4497
4498 msg "all loops unrolled"
4499 make clean
4500 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"
4501 ./tests/test_suite_shax
4502
4503 msg "all loops rolled up"
4504 make clean
4505 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"
4506 ./tests/test_suite_shax
4507}
4508
Jerry Yub6d39c22023-08-16 15:11:48 +08004509support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004510 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004511}
4512
4513component_test_aesni_m32 () { # ~ 60s
4514 # This tests are duplicated from component_test_aesni for i386 target
4515 #
4516 # AESNI intrinsic code supports i386 and assembly code does not support it.
4517
4518 msg "build: default config with different AES implementations"
4519 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004520 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4521 scripts/config.py set MBEDTLS_HAVE_ASM
4522
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004523 # test the intrinsics implementation with gcc
4524 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004525 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004526 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004527 # check that we built intrinsics - this should be used by default when supported by the compiler
4528 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4529 grep -q "AES note: using AESNI" ./programs/test/selftest
4530 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004531 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4532
4533 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004534 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4535 msg "AES tests, test AESNI only"
4536 make clean
4537 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4538 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4539 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4540 grep -q "AES note: using AESNI" ./programs/test/selftest
4541 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004542 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4543}
4544
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004545support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004546 # clang >= 4 is required to build with target attributes
4547 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004548}
4549
4550component_test_aesni_m32_clang() {
4551
4552 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004553 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4554 scripts/config.py set MBEDTLS_HAVE_ASM
4555
4556 # test the intrinsics implementation with clang
4557 msg "AES tests, test intrinsics (clang)"
4558 make clean
4559 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4560 # check that we built intrinsics - this should be used by default when supported by the compiler
4561 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4562 grep -q "AES note: using AESNI" ./programs/test/selftest
4563 grep -q "AES note: built-in implementation." ./programs/test/selftest
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004564 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4565}
4566
Jerry Yu193cbc02023-08-03 17:06:29 +08004567# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4568component_build_aes_aesce_armcc () {
4569 msg "Build: AESCE test on arm64 platform without plain C."
4570 scripts/config.py baremetal
4571
4572 # armc[56] don't support SHA-512 intrinsics
4573 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4574
4575 # Stop armclang warning about feature detection for A64_CRYPTO.
4576 # With this enabled, the library does build correctly under armclang,
4577 # but in baremetal builds (as tested here), feature detection is
4578 # unavailable, and the user is notified via a #warning. So enabling
4579 # this feature would prevent us from building with -Werror on
4580 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004581 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004582 scripts/config.py set MBEDTLS_HAVE_ASM
4583
4584 msg "AESCE, build with default configuration."
4585 scripts/config.py set MBEDTLS_AESCE_C
4586 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4587 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4588
4589 msg "AESCE, build AESCE only"
4590 scripts/config.py set MBEDTLS_AESCE_C
4591 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4592 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4593}
4594
Dave Rodgman0c584032023-10-08 12:26:54 +01004595support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004596 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004597 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004598}
4599
4600component_build_aes_armce () {
4601 # Test variations of AES with Armv8 crypto extensions
4602 scripts/config.py set MBEDTLS_AESCE_C
4603 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4604
4605 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004606 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004607
4608 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004609 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004610
4611 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004612 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgman0c584032023-10-08 12:26:54 +01004613
Dave Rodgman5e419372023-10-23 15:30:20 +01004614 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004615
Dave Rodgman5e419372023-10-23 15:30:20 +01004616 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004617 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004618
Dave Rodgman5e419372023-10-23 15:30:20 +01004619 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004620 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004621
Dave Rodgman5e419372023-10-23 15:30:20 +01004622 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004623 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004624
4625 # test for presence of AES instructions
4626 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4627 msg "clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004628 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4629 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004630 msg "clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004631 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4632 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004633 msg "clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004634 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4635 grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004636
4637 # test for absence of AES instructions
4638 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4639 scripts/config.py unset MBEDTLS_AESCE_C
4640 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004641 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4642 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004643 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004644 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4645 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004646 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004647 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4648 not grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004649}
4650
Dave Rodgman9ed18532023-10-05 00:06:47 +01004651support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004652 # clang >= 4 is required to build with SHA extensions
4653 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004654}
4655
Dave Rodgmand9e80832023-10-04 17:17:46 +01004656component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004657 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004658
4659
4660 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004661 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004662 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004663 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004664 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004665 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004666 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004667
Dave Rodgmand9e80832023-10-04 17:17:46 +01004668
Dave Rodgman94a634d2023-10-10 12:59:29 +01004669 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004670 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004671 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004672 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004673 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004674
Dave Rodgman5b89c552023-10-10 14:59:02 +01004675 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004676 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004677 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004678 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004679
Dave Rodgmancd654002023-10-05 09:40:07 +01004680
Dave Rodgman94a634d2023-10-10 12:59:29 +01004681 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004682 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004683 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004684 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004685 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004686 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004687 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004688
Dave Rodgmancd654002023-10-05 09:40:07 +01004689
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004690 # examine the disassembly for presence of SHA instructions
4691 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4692 scripts/config.py set ${opt}
4693 msg "${opt} clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004694 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4695 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004696
4697 msg "${opt} clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004698 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4699 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004700
4701 msg "${opt} clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004702 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4703 grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004704 scripts/config.py unset ${opt}
4705 done
4706
4707
4708 # examine the disassembly for absence of SHA instructions
4709 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004710 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4711 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004712
4713 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004714 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4715 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004716
4717 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004718 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4719 not grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004720}
4721
Jerry Yu193cbc02023-08-03 17:06:29 +08004722support_build_aes_aesce_armcc () {
4723 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004724}
4725
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004726component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004727 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004728 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004729
Dave Rodgmand8d64512023-12-19 12:20:21 +00004730 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004731
4732 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4733 make test
4734}
4735
4736component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4737 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4738 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004739 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004740
Hanno Becker83ebf782017-07-07 12:29:15 +01004741 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004742
4743 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004744 make test
4745}
Gilles Peskine8f073122018-11-27 15:58:47 +01004746
Hanno Becker83ebf782017-07-07 12:29:15 +01004747component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004748 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4749 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004750 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004751 scripts/config.py unset MBEDTLS_AESCE_C
4752
Dave Rodgmand8d64512023-12-19 12:20:21 +00004753 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004754
4755 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004756 make test
4757
4758 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4759 programs/test/selftest
4760}
4761
Matthias Schulz0767fda2024-02-07 10:46:28 +01004762component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004763 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4764 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004765 scripts/config.py unset MBEDTLS_AESNI_C
4766 scripts/config.py unset MBEDTLS_AESCE_C
4767
4768 make CFLAGS='-O2 -Werror -Wall -Wextra'
4769
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004770 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004771 make test
4772}
4773
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004774component_test_aes_fewer_tables () {
4775 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004776 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004777 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004778
Gilles Peskine7c652162017-12-11 00:01:40 +01004779 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004780 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004781}
4782
4783component_test_aes_rom_tables () {
4784 msg "build: default config with AES_ROM_TABLES enabled"
4785 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004786 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004787
4788 msg "test: AES_ROM_TABLES"
4789 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004790}
4791
Gilles Peskine14c3c062018-01-29 21:25:12 +01004792component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004793 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4794 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4795 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004796 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004797
Gilles Peskine8f073122018-11-27 15:58:47 +01004798 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4799 make test
4800}
4801
Yanray Wang49cd4b52023-11-10 11:58:37 +08004802# helper for common_block_cipher_no_decrypt() which:
4803# - enable/disable the list of config options passed from -s/-u respectively.
4804# - build
4805# - test for tests_suite_xxx
4806# - selftest
4807#
4808# Usage: helper_block_cipher_no_decrypt_build_test
4809# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4810# Options: -s set_opts the list of config options to enable
4811# -u unset_opts the list of config options to disable
4812# -c cflags the list of options passed to CFLAGS
4813# -l ldflags the list of options passed to LDFLAGS
4814helper_block_cipher_no_decrypt_build_test () {
4815 while [ $# -gt 0 ]; do
4816 case "$1" in
4817 -s)
4818 shift; local set_opts="$1";;
4819 -u)
4820 shift; local unset_opts="$1";;
4821 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004822 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004823 -l)
4824 shift; local ldflags="$1";;
4825 esac
4826 shift
4827 done
4828 set_opts="${set_opts:-}"
4829 unset_opts="${unset_opts:-}"
4830 cflags="${cflags:-}"
4831 ldflags="${ldflags:-}"
4832
Yanray Wangb2d6e522023-11-13 16:57:47 +08004833 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4834 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004835
4836 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4837 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004838 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004839
4840 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004841 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4842 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4843 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004844 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004845 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004846 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
Ronald Cron709bbf02024-07-03 07:59:30 +02004847 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004848
4849 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4850 make test
4851
4852 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4853 programs/test/selftest
4854}
4855
4856# This is a common configuration function used in:
4857# - component_test_block_cipher_no_decrypt_aesni_legacy()
4858# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4859# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4860# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4861# on x86.
4862common_block_cipher_no_decrypt () {
4863 # test AESNI intrinsics
4864 helper_block_cipher_no_decrypt_build_test \
4865 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004866 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004867
4868 # test AESNI assembly
4869 helper_block_cipher_no_decrypt_build_test \
4870 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004871 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004872
4873 # test AES C implementation
4874 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004875 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004876
4877 # test AESNI intrinsics for i386 target
4878 helper_block_cipher_no_decrypt_build_test \
4879 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004880 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004881 -l "-m32"
4882}
4883
Yanray Wang3ae11992023-11-13 17:32:09 +08004884# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4885# usage: 0: no PSA crypto configuration
4886# 1: use PSA crypto configuration
4887config_block_cipher_no_decrypt () {
4888 use_psa=$1
4889
Yanray Wang66111392023-10-31 18:54:54 +08004890 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004891 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4892 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004893 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004894 scripts/config.py unset MBEDTLS_NIST_KW_C
4895
Yanray Wang3ae11992023-11-13 17:32:09 +08004896 if [ "$use_psa" -eq 1 ]; then
4897 # Enable support for cryptographic mechanisms through the PSA API.
4898 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4899 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4900 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4901 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4902 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4903 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4904 fi
4905}
4906
4907component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004908 # This consistently causes an llvm crash on clang 3.8, so use gcc
4909 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004910 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004911 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004912}
4913
Yanray Wangf1496402023-11-01 18:55:13 +08004914component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004915 # This consistently causes an llvm crash on clang 3.8, so use gcc
4916 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004917 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004918 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004919}
4920
Yanray Wang66111392023-10-31 18:54:54 +08004921support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004922 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08004923}
4924
Yanray Wang66111392023-10-31 18:54:54 +08004925component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08004926 scripts/config.py baremetal
4927
4928 # armc[56] don't support SHA-512 intrinsics
4929 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4930
4931 # Stop armclang warning about feature detection for A64_CRYPTO.
4932 # With this enabled, the library does build correctly under armclang,
4933 # but in baremetal builds (as tested here), feature detection is
4934 # unavailable, and the user is notified via a #warning. So enabling
4935 # this feature would prevent us from building with -Werror on
4936 # armclang. Tracked in #7198.
4937 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4938 scripts/config.py set MBEDTLS_HAVE_ASM
4939
Yanray Wang3ae11992023-11-13 17:32:09 +08004940 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08004941
4942 # test AESCE baremetal build
4943 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08004944 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08004945 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08004946
Yanray Wangef1b04d2023-09-08 11:09:26 +08004947 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004948 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4949 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4950 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wangef1b04d2023-09-08 11:09:26 +08004951 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004952 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004953 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Ronald Cron709bbf02024-07-03 07:59:30 +02004954 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
4955 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08004956}
4957
Gilles Peskine592f5912019-10-07 18:49:32 +02004958component_test_ctr_drbg_aes_256_sha_256 () {
4959 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4960 scripts/config.py full
4961 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4962 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004963 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004964 make
4965
4966 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4967 make test
4968}
4969
4970component_test_ctr_drbg_aes_128_sha_512 () {
4971 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004972 scripts/config.py full
4973 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4974 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00004975 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004976 make
4977
4978 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
4979 make test
4980}
4981
4982component_test_ctr_drbg_aes_128_sha_256 () {
4983 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004984 scripts/config.py full
4985 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4986 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
4987 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004988 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004989 make
4990
4991 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4992 make test
4993}
4994
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004995component_test_se_default () {
4996 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004997 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02004998 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004999
5000 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5001 make test
5002}
5003
Steven Cooremand57203d2020-07-16 20:28:59 +02005004component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005005 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005006 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005007 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005008 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5009 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005010 loc_cflags="${loc_cflags} -I../tests/include -O2"
5011
Gilles Peskine21570cf2023-12-22 11:49:50 +01005012 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005013
Gilles Peskine1997f302023-07-26 18:45:20 +02005014 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005015 make test
5016}
5017
Gilles Peskine8f073122018-11-27 15:58:47 +01005018component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005019 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005020 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005021 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005022 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005023}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005024
Gilles Peskinecf740502019-07-03 20:43:05 +02005025component_test_cmake_shared () {
5026 msg "build/test: cmake shared" # ~ 2min
5027 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5028 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005029 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005030 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005031 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005032}
5033
Gilles Peskineec10bf12019-09-20 19:56:06 +02005034test_build_opt () {
5035 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005036 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005037 for opt in "$@"; do
5038 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005039 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005040 # We're confident enough in compilers to not run _all_ the tests,
5041 # but at least run the unit tests. In particular, runs with
5042 # optimizations use inline assembly whereas runs with -O0
5043 # skip inline assembly.
5044 make test # ~30s
5045 make clean
5046 done
5047}
5048
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005049# For FreeBSD we invoke the function by name so this condition is added
5050# to disable the existing test_clang_opt function for linux.
5051if [[ $(uname) != "Linux" ]]; then
5052 component_test_clang_opt () {
5053 scripts/config.py full
5054 test_build_opt 'full config' clang -O0 -Os -O2
5055 }
5056fi
5057
5058component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005059 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005060 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005061}
5062support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005063 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005064}
5065
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005066component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005067 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005068 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005069}
5070support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005071 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005072}
5073
5074component_test_gcc_latest_opt () {
5075 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005076 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005077}
5078support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005079 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005080}
5081
5082component_test_gcc_earliest_opt () {
5083 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005084 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005085}
5086support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005087 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005088}
5089
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005090component_build_mbedtls_config_file () {
5091 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005092 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005093 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005094 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005095 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005096 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5097 make clean
5098
5099 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5100 # In the user config, disable one feature (for simplicity, pick a feature
5101 # that nothing else depends on).
5102 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005103 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005104 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5105
5106 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005107}
5108
Gilles Peskine7d904e72022-04-07 21:59:14 +02005109component_build_psa_config_file () {
5110 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5111 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5112 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5113 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5114 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005115 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005116 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5117 make clean
5118
5119 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005120 # In the user config, disable one feature and its dependencies, which will
5121 # reflect on the mbedtls configuration so we can query it with
5122 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005123 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005124 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005125 scripts/config.py unset MBEDTLS_CMAC_C
5126 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5127 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5128
5129 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005130}
5131
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005132component_build_psa_alt_headers () {
5133 msg "build: make with PSA alt headers" # ~20s
5134
5135 # Generate alternative versions of the substitutable headers with the
5136 # same content except different include guards.
5137 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5138
5139 # Build the library and some programs.
5140 # Don't build the fuzzers to avoid having to go through hoops to set
5141 # a correct include path for programs/fuzz/Makefile.
5142 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
5143 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\"'"
5144
5145 # Check that we're getting the alternative include guards and not the
5146 # original include guards.
5147 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5148 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5149 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5150 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5151}
5152
Dave Rodgman852de3c2023-12-14 14:46:45 +00005153component_test_m32_no_asm () {
5154 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005155 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005156 #
5157 # Note that we require gcc, because clang Asan builds fail to link for
5158 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005159 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005160 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005161 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005162 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005163 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005164
Dave Rodgman852de3c2023-12-14 14:46:45 +00005165 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005166 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005167}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005168support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005169 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005170 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005171 *) false;;
5172 esac
5173}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005174
Gilles Peskineff0aee02021-10-05 09:36:03 +02005175component_test_m32_o2 () {
5176 # Build with optimization, to use the i386 specific inline assembly
5177 # and go faster for tests.
5178 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005179 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005180 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005181 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005182
Gilles Peskineff0aee02021-10-05 09:36:03 +02005183 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005184 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005185
Gilles Peskineff0aee02021-10-05 09:36:03 +02005186 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005187 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005188}
Gilles Peskinecf522222021-10-07 19:25:29 +02005189support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005190 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005191}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005192
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005193component_test_m32_everest () {
5194 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005195 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005196 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005197 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005198
5199 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5200 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005201
5202 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005203 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005204
5205 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5206 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005207 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005208}
5209support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005210 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005211}
5212
Gilles Peskine8f073122018-11-27 15:58:47 +01005213component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005214 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005215 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005216 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005217
5218 msg "test: 64-bit ILP32, make, gcc"
5219 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005220}
Gilles Peskine878cf602019-01-06 20:50:38 +00005221support_test_mx32 () {
5222 case $(uname -m) in
5223 amd64|x86_64) true;;
5224 *) false;;
5225 esac
5226}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005227
Peter Kolbus60c6da22018-12-27 06:59:04 -06005228component_test_min_mpi_window_size () {
5229 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005230 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005231 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005232 make
5233
5234 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5235 make test
5236}
5237
Gilles Peskine8f073122018-11-27 15:58:47 +01005238component_test_have_int32 () {
5239 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005240 scripts/config.py unset MBEDTLS_HAVE_ASM
5241 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005242 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005243 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005244
Gilles Peskine8f073122018-11-27 15:58:47 +01005245 msg "test: gcc, force 32-bit bignum limbs"
5246 make test
5247}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005248
Gilles Peskine8f073122018-11-27 15:58:47 +01005249component_test_have_int64 () {
5250 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005251 scripts/config.py unset MBEDTLS_HAVE_ASM
5252 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005253 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005254 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005255
Gilles Peskine8f073122018-11-27 15:58:47 +01005256 msg "test: gcc, force 64-bit bignum limbs"
5257 make test
5258}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005259
Gabor Mezeie256cc12023-07-26 17:28:48 +02005260component_test_have_int32_cmake_new_bignum () {
5261 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5262 scripts/config.py unset MBEDTLS_HAVE_ASM
5263 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005264 scripts/config.py unset MBEDTLS_AESCE_C
5265 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005266 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005267 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005268
5269 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5270 make test
5271}
5272
Gilles Peskine8f073122018-11-27 15:58:47 +01005273component_test_no_udbl_division () {
5274 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005275 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005276 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005277 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005278
Gilles Peskine8f073122018-11-27 15:58:47 +01005279 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5280 make test
5281}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005282
Gilles Peskine8f073122018-11-27 15:58:47 +01005283component_test_no_64bit_multiplication () {
5284 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005285 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005286 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005287 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005288
Gilles Peskine8f073122018-11-27 15:58:47 +01005289 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5290 make test
5291}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005292
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005293component_test_no_strings () {
5294 msg "build: no strings" # ~10s
5295 scripts/config.py full
5296 # Disable options that activate a large amount of string constants.
5297 scripts/config.py unset MBEDTLS_DEBUG_C
5298 scripts/config.py unset MBEDTLS_ERROR_C
5299 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5300 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005301 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005302
5303 msg "test: no strings" # ~ 10s
5304 make test
5305}
5306
Hanno Beckerc5722d12020-10-09 11:10:42 +01005307component_test_no_x509_info () {
5308 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5309 scripts/config.pl full
5310 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5311 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005312 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005313
5314 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5315 make test
5316
5317 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005318 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005319}
5320
Gilles Peskine8f073122018-11-27 15:58:47 +01005321component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005322 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005323 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005324 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 +02005325
Gilles Peskinee36fe812021-09-01 20:00:33 +02005326 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005327 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005328 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005329 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005330}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005331
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005332component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005333 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005334 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005335 # Build for a target platform that's close to what Debian uses
5336 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005337 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005338 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005339 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005340 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'
5341
Gilles Peskinee36fe812021-09-01 20:00:33 +02005342 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005343 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005344 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005345 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005346}
5347support_build_arm_linux_gnueabi_gcc_arm5vte () {
5348 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5349}
5350
5351component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005352 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005353 scripts/config.py baremetal
5354 # This is an imperfect substitute for
5355 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005356 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005357 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 +02005358
Gilles Peskinee36fe812021-09-01 20:00:33 +02005359 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005360 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005361 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005362 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005363}
5364
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005365component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005366 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5367 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005368 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 +02005369
Gilles Peskinee36fe812021-09-01 20:00:33 +02005370 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005371 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005372 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005373 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005374 for lib in library/*.a; do
5375 echo "$lib:"
5376 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5377 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005378}
5379
Gilles Peskine8f073122018-11-27 15:58:47 +01005380component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005381 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005382 scripts/config.py baremetal
5383 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005384 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-std=c99 -Werror -Wall -Wextra' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01005385 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005386 not grep __aeabi_uldiv library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005387 not grep __aeabi_uldiv ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005388 not grep __aeabi_uldiv ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005389}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005390
Gilles Peskine8f073122018-11-27 15:58:47 +01005391component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005392 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005393 scripts/config.py baremetal
5394 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005395 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 +01005396 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005397 not grep __aeabi_lmul library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005398 not grep __aeabi_lmul ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005399 not grep __aeabi_lmul ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005400}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005401
Dave Rodgman8c315f22023-06-02 10:26:24 -04005402component_build_arm_clang_thumb () {
5403 # ~ 30s
5404
5405 scripts/config.py baremetal
5406
5407 msg "build: clang thumb 2, make"
5408 make clean
5409 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5410
5411 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5412 msg "build: clang thumb 1 -O0, make"
5413 make clean
5414 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5415
5416 msg "build: clang thumb 1 -Os, make"
5417 make clean
5418 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5419}
5420
Gilles Peskine8f073122018-11-27 15:58:47 +01005421component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005422 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005423 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005424 # armc[56] don't support SHA-512 intrinsics
5425 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005426
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005427 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5428 scripts/config.py unset MBEDTLS_AESCE_C
5429
Dave Rodgman0fddf822023-03-02 15:32:12 +00005430 # Stop armclang warning about feature detection for A64_CRYPTO.
5431 # With this enabled, the library does build correctly under armclang,
5432 # but in baremetal builds (as tested here), feature detection is
5433 # unavailable, and the user is notified via a #warning. So enabling
5434 # this feature would prevent us from building with -Werror on
5435 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005436 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005437
Hanno Beckerf0762e92022-07-15 12:08:19 +01005438 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005439
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005440 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005441
5442 msg "size: ARM Compiler 5"
5443 "$ARMC5_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005444 "$ARMC5_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005445 "$ARMC5_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine18487f62020-04-30 23:11:54 +02005446
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005447 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005448
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005449 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005450 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005451
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005452 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005453 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5454
5455 # ARM Compiler 6 - Target ARMv7-M+DSP
5456 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005457
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005458 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005459 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005460
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005461 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005462 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005463
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005464 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5465 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5466
Dave Rodgman99318e62023-05-24 12:27:42 +01005467 # ARM Compiler 6 - Target Cortex-M0
5468 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005469
5470 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5471 #
5472 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5473 # that we have in our CI
5474 scripts/config.py set MBEDTLS_AESCE_C
5475 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005476}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005477
Pengyu Lvdf070032023-02-24 16:03:31 +08005478support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005479 armc5_cc="$ARMC5_BIN_DIR/armcc"
5480 armc6_cc="$ARMC6_BIN_DIR/armclang"
5481 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005482}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005483
Ronald Crond2cb7f42024-03-18 12:49:18 +01005484component_test_tls12_only () {
5485 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5486 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5487 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5488 make
5489
5490 msg "test: main suites (inc. selftests) (ASan build)"
5491 make test
5492
5493 msg "test: ssl-opt.sh (ASan build)"
5494 tests/ssl-opt.sh
5495
5496 msg "test: compat.sh (ASan build)"
5497 tests/compat.sh
5498}
5499
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005500component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005501 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005502 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005503 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005504 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5505
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005506 msg "test: TLS 1.3 only, all key exchange modes enabled"
5507 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005508
Ronald Cronc3f43b62022-10-17 17:35:32 +02005509 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5510 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005511}
5512
Ronald Cronc3f43b62022-10-17 17:35:32 +02005513component_test_tls13_only_psk () {
5514 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5515 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5516 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5517 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005518 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005519 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5520 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5521 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5522 scripts/config.py unset MBEDTLS_ECDSA_C
5523 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005524 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005525 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005526 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5527
Ronald Cronc3f43b62022-10-17 17:35:32 +02005528 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5529 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005530
Ronald Cronc3f43b62022-10-17 17:35:32 +02005531 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5532 tests/ssl-opt.sh
5533}
5534
5535component_test_tls13_only_ephemeral () {
5536 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5537 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5538 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005539 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005540 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5541
5542 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5543 cd tests; ./test_suite_ssl; cd ..
5544
5545 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5546 tests/ssl-opt.sh
5547}
5548
Przemek Stekiela01c2422023-06-13 10:46:48 +02005549component_test_tls13_only_ephemeral_ffdh () {
5550 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5551 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5552 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5553 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005554 scripts/config.py unset MBEDTLS_ECDH_C
5555
Przemek Stekiela01c2422023-06-13 10:46:48 +02005556 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5557
5558 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5559 cd tests; ./test_suite_ssl; cd ..
5560
5561 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5562 tests/ssl-opt.sh
5563}
5564
Ronald Cronc3f43b62022-10-17 17:35:32 +02005565component_test_tls13_only_psk_ephemeral () {
5566 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5567 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5568 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5569 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5570 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5571 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5572 scripts/config.py unset MBEDTLS_ECDSA_C
5573 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005574 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005575 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005576 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5577
5578 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5579 cd tests; ./test_suite_ssl; cd ..
5580
5581 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5582 tests/ssl-opt.sh
5583}
5584
Przemek Stekiela01c2422023-06-13 10:46:48 +02005585component_test_tls13_only_psk_ephemeral_ffdh () {
5586 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5587 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5588 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5589 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5590 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5591 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5592 scripts/config.py unset MBEDTLS_ECDSA_C
5593 scripts/config.py unset MBEDTLS_PKCS1_V21
5594 scripts/config.py unset MBEDTLS_PKCS7_C
5595 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005596 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005597 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5598
5599 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5600 cd tests; ./test_suite_ssl; cd ..
5601
5602 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5603 tests/ssl-opt.sh
5604}
5605
Ronald Cronc3f43b62022-10-17 17:35:32 +02005606component_test_tls13_only_psk_all () {
5607 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5608 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5609 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5610 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5611 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5612 scripts/config.py unset MBEDTLS_ECDSA_C
5613 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005614 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005615 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005616 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5617
5618 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5619 cd tests; ./test_suite_ssl; cd ..
5620
5621 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5622 tests/ssl-opt.sh
5623}
5624
5625component_test_tls13_only_ephemeral_all () {
5626 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5627 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005628 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005629 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5630
5631 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5632 cd tests; ./test_suite_ssl; cd ..
5633
5634 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5635 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005636}
5637
Ronald Cron46ac0652024-03-18 12:39:04 +01005638component_test_tls13_no_padding () {
5639 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005640 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005641 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005642 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005643 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005644 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005645 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005646 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005647 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005648}
5649
Ronald Cron6f135e12021-12-08 16:57:54 +01005650component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005651 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005652 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005653 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005654 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005655 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005656 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005657 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005658 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005659 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005660}
5661
Ronald Crondd96c0a2024-04-02 12:34:24 +02005662component_test_full_minus_session_tickets() {
5663 msg "build: full config without session tickets"
5664 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005665 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005666 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005667 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5668 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005669 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005670 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005671 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005672 tests/ssl-opt.sh
5673}
5674
Gilles Peskine8f073122018-11-27 15:58:47 +01005675component_build_mingw () {
5676 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005677 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 +00005678
Gilles Peskine8f073122018-11-27 15:58:47 +01005679 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005680 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 +01005681 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005682
Gilles Peskine8f073122018-11-27 15:58:47 +01005683 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005684 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
5685 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 +01005686 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005687
Pengyu Lv158eead2023-10-19 11:27:05 +08005688 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005689 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005690 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 +01005691 make WINDOWS_BUILD=1 clean
5692}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005693support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005694 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5695 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005696 *) true;;
5697 esac
5698}
Simon Butcher91aef332016-11-17 09:20:50 +00005699
Gilles Peskine8f073122018-11-27 15:58:47 +01005700component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005701 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005702 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005703 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5704 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005705
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005706 msg "test: main suites (MSan)" # ~ 10s
5707 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005708
Gilles Peskine6848d172023-11-02 19:58:03 +01005709 msg "test: metatests (MSan)"
5710 tests/scripts/run-metatests.sh any msan
5711
Gilles Peskine82b27272019-06-14 18:27:03 +02005712 msg "program demos (MSan)" # ~20s
5713 tests/scripts/run_demos.py
5714
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005715 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005716 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005717
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005718 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005719
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005720 if [ "$MEMORY" -gt 0 ]; then
5721 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005722 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005723 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005724}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005725
Bence Szépkúti0354d042023-12-06 16:14:37 +01005726component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005727 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005728 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005729 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5730 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005731
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005732 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005733 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005734
Gilles Peskine636c26a2020-03-04 20:46:15 +01005735 # Optional parts (slow; currently broken on OS X because programs don't
5736 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005737 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005738 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005739 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005740 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005741 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005742
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005743 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005744 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005745 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005746 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005747
5748 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005749 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005750 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005751 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005752}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005753
Bence Szépkúti0354d042023-12-06 16:14:37 +01005754component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005755 msg "build: Release, full (clang)"
5756 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5757 scripts/config.py full
5758 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5759 make
5760
5761 msg "test: main suites, Valgrind (full config)"
5762 make memcheck
5763}
5764
Paul Elliott62dc3922021-11-25 17:29:40 +00005765support_test_cmake_out_of_source () {
5766 distrib_id=""
5767 distrib_ver=""
5768 distrib_ver_minor=""
5769 distrib_ver_major=""
5770
5771 # Attempt to parse lsb-release to find out distribution and version. If not
5772 # found this should fail safe (test is supported).
5773 if [[ -f /etc/lsb-release ]]; then
5774
5775 while read -r lsb_line; do
5776 case "$lsb_line" in
5777 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5778 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5779 esac
5780 done < /etc/lsb-release
5781
5782 distrib_ver_major="${distrib_ver%%.*}"
5783 distrib_ver="${distrib_ver#*.}"
5784 distrib_ver_minor="${distrib_ver%%.*}"
5785 fi
5786
5787 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5788 # processor (as the CI does) can create a race condition whereby the build
5789 # fails to see a generated file, despite that file actually having been
5790 # generated. This problem appears to go away with 18.04 or newer, so make
5791 # the out of source tests unsupported on Ubuntu 16.04.
5792 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5793}
5794
Gilles Peskine8f073122018-11-27 15:58:47 +01005795component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005796 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005797 # generates
5798 make neat
5799
Gilles Peskine8f073122018-11-27 15:58:47 +01005800 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005801 MBEDTLS_ROOT_DIR="$PWD"
5802 mkdir "$OUT_OF_SOURCE_DIR"
5803 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005804 # Note: Explicitly generate files as these are turned off in releases
5805 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005806 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005807
Gilles Peskine8f073122018-11-27 15:58:47 +01005808 msg "test: cmake 'out-of-source' build"
5809 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005810 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005811 # Also ensure that there are no error messages such as
5812 # "No such file or directory", which would indicate that some required
5813 # file is missing (ssl-opt.sh tolerates the absence of some files so
5814 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005815 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005816 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005817 cat ssl-opt.err >&2
5818 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005819 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005820 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005821 cd "$MBEDTLS_ROOT_DIR"
5822 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005823}
Andres AGdc192212016-08-31 17:33:13 +01005824
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005825component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005826 # Remove existing generated files so that we use the ones CMake
5827 # generates
5828 make neat
5829
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005830 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005831 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005832 # Note: Explicitly generate files as these are turned off in releases
5833 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005834 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005835 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005836}
Gilles Peskinea3000992022-02-04 00:21:12 +01005837support_test_cmake_as_subdirectory () {
5838 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005839}
5840
Chris Kayd259e342021-03-25 16:03:25 +00005841component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005842 # Remove existing generated files so that we use the ones CMake
5843 # generates
5844 make neat
5845
Chris Kayd259e342021-03-25 16:03:25 +00005846 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005847 cd programs/test/cmake_package
5848 cmake .
5849 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005850 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005851}
Gilles Peskinea3000992022-02-04 00:21:12 +01005852support_test_cmake_as_package () {
5853 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005854}
5855
5856component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005857 # Remove existing generated files so that we use the ones CMake
5858 # generates
5859 make neat
5860
Chris Kayd259e342021-03-25 16:03:25 +00005861 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005862 cd programs/test/cmake_package_install
5863 cmake .
5864 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005865 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005866}
Gilles Peskinea3000992022-02-04 00:21:12 +01005867support_test_cmake_as_package_install () {
5868 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005869}
5870
David Horstmann20550e32023-01-12 14:17:01 +00005871component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005872 # Make a copy of config file to use for the in-tree test
5873 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005874
5875 MBEDTLS_ROOT_DIR="$PWD"
5876 mkdir "$OUT_OF_SOURCE_DIR"
5877 cd "$OUT_OF_SOURCE_DIR"
5878
David Horstmann969c1452023-01-31 10:34:44 +00005879 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005880 cmake "$MBEDTLS_ROOT_DIR"
5881 make
5882
5883 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5884 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005885 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005886 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5887 make
5888
5889 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5890 # In the user config, disable one feature (for simplicity, pick a feature
5891 # that nothing else depends on).
5892 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5893
5894 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5895 make
5896 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5897
5898 rm -f user_config.h full_config.h
5899
5900 cd "$MBEDTLS_ROOT_DIR"
5901 rm -rf "$OUT_OF_SOURCE_DIR"
5902
5903 # Now repeat the test for an in-tree build:
5904
David Horstmann969c1452023-01-31 10:34:44 +00005905 # Restore config for the in-tree test
5906 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005907
David Horstmann969c1452023-01-31 10:34:44 +00005908 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005909 cmake .
5910 make
5911
5912 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5913 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005914 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005915 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5916 make
5917
5918 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5919 # In the user config, disable one feature (for simplicity, pick a feature
5920 # that nothing else depends on).
5921 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5922
5923 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5924 make
5925 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5926
5927 rm -f user_config.h full_config.h
5928}
5929support_build_cmake_custom_config_file () {
5930 support_test_cmake_out_of_source
5931}
5932
David Horstmann041ed422024-05-10 14:37:48 +01005933component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01005934 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01005935 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
5936 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
5937 make
5938}
5939support_build_cmake_programs_no_testing () {
5940 support_test_cmake_out_of_source
5941}
David Horstmann20550e32023-01-12 14:17:01 +00005942
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005943component_build_zeroize_checks () {
5944 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5945
5946 scripts/config.py full
5947
5948 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00005949 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 +01005950}
5951
5952
Gilles Peskine8f073122018-11-27 15:58:47 +01005953component_test_zeroize () {
5954 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5955 # different combinations of compilers and optimization flags by using an
5956 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5957 # system in all cases that the script fails, so we must manually search the
5958 # output to check whether the pass string is present and no failure strings
5959 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005960
Gilles Peskine4976e822019-01-06 19:52:22 +00005961 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5962 # about a spurious message if Gdb tries and fails, so suppress that.
5963 gdb_disable_aslr=
5964 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
5965 gdb_disable_aslr='set disable-randomization off'
5966 fi
5967
Gilles Peskine8f073122018-11-27 15:58:47 +01005968 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01005969 for compiler in clang gcc; do
5970 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
5971 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005972 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
5973 grep "The buffer was correctly zeroized" test_zeroize.log
5974 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01005975 rm -f test_zeroize.log
5976 make clean
5977 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01005978 done
Gilles Peskine8f073122018-11-27 15:58:47 +01005979}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005980
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005981component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00005982 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005983 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00005984 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005985
5986 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00005987 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005988}
5989
5990support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01005991 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02005992 ver="$(cmake --version)"
5993 ver="${ver#cmake version }"
5994 ver_major="${ver%%.*}"
5995
5996 ver="${ver#*.}"
5997 ver_minor="${ver%%.*}"
5998
5999 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006000}
6001
Gilles Peskinec848d222022-12-09 12:23:35 +01006002component_check_code_style () {
6003 msg "Check C code style"
6004 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006005}
6006
Gilles Peskinec848d222022-12-09 12:23:35 +01006007support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006008 case $(uncrustify --version) in
6009 *0.75.1*) true;;
6010 *) false;;
6011 esac
6012}
6013
Gilles Peskine8f073122018-11-27 15:58:47 +01006014component_check_python_files () {
6015 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006016 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006017}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006018
Joe Subbianid614c0b2021-07-29 11:18:29 +01006019component_check_test_helpers () {
6020 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006021 # unittest writes out mundane stuff like number or tests run on stderr.
6022 # Our convention is to reserve stderr for actual errors, and write
6023 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006024 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006025
Joe Subbiania25ffab2021-08-06 09:41:27 +01006026 msg "unit test: translate_ciphers.py"
6027 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006028}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006029
Valerio Settid9e42512024-05-06 15:59:51 +02006030component_test_psasim() {
Valerio Setti9022f712024-06-27 07:59:39 +02006031 msg "build server library and application"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006032 scripts/config.py crypto
Valerio Settid8b59372024-07-02 12:02:25 +02006033 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006034 helper_psasim_build server
Valerio Settid1b6ef12024-05-07 16:00:21 +02006035
Valerio Settid8b59372024-07-02 12:02:25 +02006036 helper_psasim_cleanup_before_client
Valerio Settif98635c2024-06-10 20:13:13 +02006037
6038 msg "build library for client"
Valerio Settid8b59372024-07-02 12:02:25 +02006039 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006040 helper_psasim_build client
Valerio Settif98635c2024-06-10 20:13:13 +02006041
Valerio Setti5beb2362024-06-24 13:13:17 +02006042 msg "build basic psasim client"
6043 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_base
6044 msg "test basic psasim client"
6045 tests/psa-client-server/psasim/test/run_test.sh psa_client_base
Valerio Settid9e42512024-05-06 15:59:51 +02006046
Valerio Setti5beb2362024-06-24 13:13:17 +02006047 msg "build full psasim client"
6048 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_full
6049 msg "test full psasim client"
6050 tests/psa-client-server/psasim/test/run_test.sh psa_client_full
Valerio Settid9e42512024-05-06 15:59:51 +02006051
Valerio Settid9e42512024-05-06 15:59:51 +02006052 make -C tests/psa-client-server/psasim clean
6053}
Jerry Yud767cc42023-03-31 15:03:55 +08006054
Valerio Setti9022f712024-06-27 07:59:39 +02006055component_test_suite_with_psasim()
6056{
6057 msg "build server library and application"
Valerio Settid8b59372024-07-02 12:02:25 +02006058 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006059 # Modify server's library configuration here (if needed)
6060 helper_psasim_build server
6061
Valerio Settid8b59372024-07-02 12:02:25 +02006062 helper_psasim_cleanup_before_client
Valerio Setti9022f712024-06-27 07:59:39 +02006063
6064 msg "build client library"
Valerio Settid8b59372024-07-02 12:02:25 +02006065 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006066 # PAKE functions are still unsupported from PSASIM
6067 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
6068 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
6069 helper_psasim_build client
6070
6071 msg "build test suites"
6072 make PSASIM=1 CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" tests
6073
6074 helper_psasim_server start
6075
Valerio Setti1a493832024-07-01 07:29:02 +02006076 # psasim takes an extremely long execution time on some test suites so we
6077 # exclude them from the list.
6078 SKIP_TEST_SUITES="constant_time_hmac,lmots,lms"
6079 export SKIP_TEST_SUITES
6080
Valerio Setti9022f712024-06-27 07:59:39 +02006081 msg "run test suites"
6082 make PSASIM=1 test
6083
6084 helper_psasim_server kill
6085}
6086
Gilles Peskine192c72f2017-12-21 15:59:21 +01006087################################################################
6088#### Termination
6089################################################################
6090
Gilles Peskine8f073122018-11-27 15:58:47 +01006091post_report () {
6092 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006093 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006094
Gilles Peskine8f073122018-11-27 15:58:47 +01006095 final_report
6096}
6097
6098
6099
6100################################################################
6101#### Run all the things
6102################################################################
6103
Gilles Peskine5d996822020-03-28 21:09:21 +01006104# Function invoked by --error-test to test error reporting.
6105pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006106 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006107 if [ $KEEP_GOING -ne 0 ]; then
6108 echo "Expect three failing commands."
6109 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006110 # If the component doesn't run in a subshell, changing error_test_i to an
6111 # invalid integer will cause an error in the loop that runs this function.
6112 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006113 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006114 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006115 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006116 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006117 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006118 make unknown_target
6119 false "this should not be executed"
6120}
6121
Gilles Peskinee48351a2018-11-27 16:06:30 +01006122# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006123run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006124 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006125 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006126
6127 # Unconditionally create a seedfile that's sufficiently long.
6128 # Do this before each component, because a previous component may
6129 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006130 local dd_cmd
6131 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6132 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006133 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006134 esac
6135 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006136
Gilles Peskineec135542021-08-02 23:14:03 +02006137 # Run the component in a subshell, with error trapping and output
6138 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006139 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006140 # We want to keep running if the subshell fails, so 'set -e' must
6141 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006142 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006143 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006144 (
6145 if [ $QUIET -eq 1 ]; then
6146 # msg() will be silenced, so just print the component name here.
6147 echo "${current_component#component_}"
6148 exec >/dev/null
6149 fi
6150 if [ $KEEP_GOING -eq 1 ]; then
6151 # Keep "set -e" off, and run an ERR trap instead to record failures.
6152 set -E
6153 trap err_trap ERR
6154 fi
6155 # The next line is what runs the component
6156 "$@"
6157 if [ $KEEP_GOING -eq 1 ]; then
6158 trap - ERR
6159 exit $last_failure_status
6160 fi
6161 )
6162 component_status=$?
6163 if [ $KEEP_GOING -eq 1 ]; then
6164 set -e
6165 if [ $component_status -ne 0 ]; then
6166 failure_count=$((failure_count + 1))
6167 fi
6168 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006169
6170 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006171 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006172 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006173}
6174
6175# Preliminary setup
6176pre_check_environment
6177pre_initialize_variables
6178pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006179
Dave Rodgman21900632024-02-26 11:41:19 +00006180setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006181pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006182pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006183pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006184
Gilles Peskine878cf602019-01-06 20:50:38 +00006185build_status=0
6186if [ $KEEP_GOING -eq 1 ]; then
6187 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006188fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006189pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006190pre_print_configuration
6191pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006192cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006193if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006194 pre_generate_files
6195fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006196
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006197# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006198for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006199 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006200done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006201unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006202for component in $RUN_COMPONENTS; do
6203 run_component "component_$component"
6204done
Gilles Peskine8f073122018-11-27 15:58:47 +01006205
6206# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006207post_report