blob: ef7ed0644d1f5368e0a5f9638248e923babc7c44 [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
Ronald Cron82803982024-07-02 08:40:24 +0200337 rm -f tf-psa-crypto/core/Makefile tf-psa-crypto/drivers/Makefile
338 rm -f tf-psa-crypto/drivers/builtin/Makefile
339 rm -f tf-psa-crypto/drivers/builtin/src/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200340
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100341 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
342 rm -rf programs/test/cmake_subproject/build
343 rm -f programs/test/cmake_subproject/Makefile
344 rm -f programs/test/cmake_subproject/cmake_subproject
345
Chris Kayd259e342021-03-25 16:03:25 +0000346 # Remove any artifacts from the component_test_cmake_as_package test.
347 rm -rf programs/test/cmake_package/build
348 rm -f programs/test/cmake_package/Makefile
349 rm -f programs/test/cmake_package/cmake_package
350
351 # Remove any artifacts from the component_test_cmake_as_installed_package test.
352 rm -rf programs/test/cmake_package_install/build
353 rm -f programs/test/cmake_package_install/Makefile
354 rm -f programs/test/cmake_package_install/cmake_package_install
355
Gilles Peskinef83eb822020-03-30 20:11:39 +0200356 # Restore files that may have been clobbered by the job
357 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200358 if [[ -e "$x$backup_suffix" ]]; then
359 cp -p "$x$backup_suffix" "$x"
360 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200361 done
362}
John Durkopbd069d32020-10-31 22:14:03 -0700363
Valerio Setti9022f712024-06-27 07:59:39 +0200364# This is a helper function to be used in psasim builds. It is meant to clean
365# up the library's workspace after the server build and before the client
366# build. Built libraries (mbedcrypto, mbedx509 and mbedtls) are supposed to be
367# already copied to psasim folder at this point.
Valerio Settid8b59372024-07-02 12:02:25 +0200368helper_psasim_cleanup_before_client() {
Valerio Setti9022f712024-06-27 07:59:39 +0200369 # Clean up library files
370 make -C library clean
371 # Clean up intermediate files that were used to build the server
372 make -C $PSASIM_PATH clean_server_intermediate_files
373 # Restore files that were backup before building library files. This
374 # includes $CONFIG_H and $CRYPTO_CONFIG_H.
375 for x in $files_to_back_up; do
376 if [[ -e "$x$backup_suffix" ]]; then
377 cp -p "$x$backup_suffix" "$x"
378 fi
379 done
380}
381
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200382# Final cleanup when this script exits (except when exiting on a failure
383# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200384final_cleanup () {
385 cleanup
386
387 for x in $files_to_back_up; do
388 rm -f "$x$backup_suffix"
389 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100390}
391
Gilles Peskine7c652162017-12-11 00:01:40 +0100392# Executed on exit. May be redefined depending on command line options.
393final_report () {
394 :
395}
396
397fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200398 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100399 final_report $1
400 trap - $1
401 kill -$1 $$
402}
403
404trap 'fatal_signal HUP' HUP
405trap 'fatal_signal INT' INT
406trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200407
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200408# Number of processors on this machine. Used as the default setting
409# for parallel make.
410all_sh_nproc ()
411{
412 {
413 nproc || # Linux
414 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
415 sysctl -n hw.ncpu || # FreeBSD
416 echo 1
417 } 2>/dev/null
418}
419
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100420msg()
421{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100422 if [ -n "${current_component:-}" ]; then
423 current_section="${current_component#component_}: $1"
424 else
425 current_section="$1"
426 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200427
428 if [ $QUIET -eq 1 ]; then
429 return
430 fi
431
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100432 echo ""
433 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100434 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000435 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100436 echo "******************************************************************"
437}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100438
Gilles Peskine8f073122018-11-27 15:58:47 +0100439armc6_build_test()
440{
441 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100442
Gilles Peskine18487f62020-04-30 23:11:54 +0200443 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800444 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100445 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000446 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200447
448 msg "size: ARM Compiler 6 ($FLAGS)"
449 "$ARMC6_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +0200450 "$ARMC6_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +0200451 "$ARMC6_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100452}
Andres AGa5cd9732016-10-17 15:23:10 +0100453
Andres AGd9eba4b2016-08-26 14:42:14 +0100454err_msg()
455{
456 echo "$1" >&2
457}
458
459check_tools()
460{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200461 for tool in "$@"; do
462 if ! `type "$tool" >/dev/null 2>&1`; then
463 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100464 exit 1
465 fi
466 done
467}
468
Gilles Peskine8f073122018-11-27 15:58:47 +0100469pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000470 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100471 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100472 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100473 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200474 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000475 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100476
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000477 # Note that legacy options are ignored instead of being omitted from this
478 # list of options, so invocations that worked with previous version of
479 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100480 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200482 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200483 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200484 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000485 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100486 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
487 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100488 --clang-earliest) shift; CLANG_EARLIEST="$1";;
489 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100490 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000491 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100492 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100493 --gcc-earliest) shift; GCC_EARLIEST="$1";;
494 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100495 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200496 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
497 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100498 --gnutls-serv) shift; GNUTLS_SERV="$1";;
499 --help|-h) usage; exit;;
500 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000501 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100502 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100503 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200504 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000505 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100506 --no-force) FORCE=0;;
507 --no-keep-going) KEEP_GOING=0;;
508 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200509 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100510 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100511 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200512 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100513 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200514 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100515 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200516 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200517 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100518 --seed|-s) shift; SEED="$1";;
519 -*)
520 echo >&2 "Unknown option: $1"
521 echo >&2 "Run $0 --help for usage."
522 exit 120
523 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000524 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100525 esac
526 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100527 done
SimonB2e23c822016-04-16 21:54:39 +0100528
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100529 # Exclude components that are not supported on this platform.
530 SUPPORTED_COMPONENTS=
531 for component in $ALL_COMPONENTS; do
532 case $(type "support_$component" 2>&1) in
533 *' function'*)
534 if ! support_$component; then continue; fi;;
535 esac
536 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
537 done
538
539 if [ $list_components -eq 1 ]; then
540 printf '%s\n' $SUPPORTED_COMPONENTS
541 exit
542 fi
543
Gilles Peskinea28db922019-01-10 00:05:18 +0100544 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200545 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000546 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100547 fi
548
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000549 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
550 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100551 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000552 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100553 fi
SimonB2e23c822016-04-16 21:54:39 +0100554
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200555 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100556 if [ $all_except -eq 0 ]; then
557 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200558 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
559 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200560 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100561 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200562 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200563 # If the requested name includes a wildcard character, don't
564 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100565 case $component in
566 *[*?\[]*) continue;;
567 esac
568 case " $SUPPORTED_COMPONENTS " in
569 *" $component "*) :;;
570 *)
571 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
572 unsupported=$((unsupported + 1));;
573 esac
574 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200575 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100576 if [ $unsupported -ne 0 ]; then
577 exit 2
578 fi
579 fi
580
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000581 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100582 RUN_COMPONENTS=
583 for component in $SUPPORTED_COMPONENTS; do
584 if is_component_included "$component"; [ $? -eq $all_except ]; then
585 RUN_COMPONENTS="$RUN_COMPONENTS $component"
586 fi
587 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000588
589 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000590 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100591}
SimonB2e23c822016-04-16 21:54:39 +0100592
Gilles Peskine8f073122018-11-27 15:58:47 +0100593pre_check_git () {
594 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100595 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100596 git checkout-index -f -q $CONFIG_H
597 cleanup
598 else
SimonB2e23c822016-04-16 21:54:39 +0100599
Gilles Peskine8f073122018-11-27 15:58:47 +0100600 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
601 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
602 echo "You can either delete this directory manually, or force the test by rerunning"
603 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
604 exit 1
605 fi
606
Ronald Cron7a93ac52023-07-20 09:49:12 +0200607 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100608 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100609 echo "You can either delete or preserve your work, or force the test by rerunning the"
610 echo "script as: $0 --force"
611 exit 1
612 fi
SimonB2e23c822016-04-16 21:54:39 +0100613 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500614}
615
Gilles Peskine568f53a2021-07-12 18:16:01 +0200616pre_restore_files () {
617 # If the makefiles have been generated by a framework such as cmake,
618 # restore them from git. If the makefiles look like modifications from
619 # the ones checked into git, take care not to modify them. Whatever
620 # this function leaves behind is what the script will restore before
621 # each component.
622 case "$(head -n1 Makefile)" in
623 *[Gg]enerated*)
624 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
625 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
626 ;;
627 esac
628}
629
Gilles Peskinef83eb822020-03-30 20:11:39 +0200630pre_back_up () {
631 for x in $files_to_back_up; do
632 cp -p "$x" "$x$backup_suffix"
633 done
634}
635
Gilles Peskine8f073122018-11-27 15:58:47 +0100636pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100637 failure_count=0 # Number of failed components
638 last_failure_status=0 # Last failure status in this component
639
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100640 # See err_trap
641 previous_failure_status=0
642 previous_failed_command=
643 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100644 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100645
Gilles Peskine7c652162017-12-11 00:01:40 +0100646 start_red=
647 end_color=
648 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100649 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100650 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
651 start_red=$(printf '\033[31m')
652 end_color=$(printf '\033[0m')
653 ;;
654 esac
655 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100656
657 # Keep a summary of failures in a file. We'll print it out at the end.
658 failure_summary_file=$PWD/all-sh-failures-$$.log
659 : >"$failure_summary_file"
660
661 # Whether it makes sense to keep a component going after the specified
662 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200663 # This function normally receives the failing simple command
664 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
665 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100666 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200667 # False positives result in running things that can't be expected to
668 # work. False negatives result in things not running after something else
669 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100670 can_keep_going_after_failure () {
671 case "$1" in
672 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200673 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100674 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200675 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
676 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
677 *make*check*) true;;
678 "grep "*) true;;
679 "[ "*) true;;
680 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100682 esac
683 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100684
685 # This function runs if there is any error in a component.
686 # It must either exit with a nonzero status, or set
687 # last_failure_status to a nonzero value.
688 err_trap () {
689 # Save $? (status of the failing command). This must be the very
690 # first thing, before $? is overridden.
691 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100692 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100693
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100694 if [[ $last_failure_status -eq $previous_failure_status &&
695 "$failed_command" == "$previous_failed_command" &&
696 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
697 then
698 # The same command failed twice in a row, but this time one level
699 # less deep in the function call stack. This happens when the last
700 # command of a function returns a nonzero status, and the function
701 # returns that same status. Ignore the second failure.
702 previous_failure_funcall_depth=${#FUNCNAME[@]}
703 return
704 fi
705 previous_failure_status=$last_failure_status
706 previous_failed_command=$failed_command
707 previous_failure_funcall_depth=${#FUNCNAME[@]}
708
Gilles Peskinece266c42020-03-28 18:50:43 +0100709 text="$current_section: $failed_command -> $last_failure_status"
710 echo "${start_red}^^^^$text^^^^${end_color}" >&2
711 echo "$text" >>"$failure_summary_file"
712
713 # If the command is fatal (configure or build command), stop this
714 # component. Otherwise (test command) keep the component running
715 # (run more tests from the same build).
716 if ! can_keep_going_after_failure "$failed_command"; then
717 exit $last_failure_status
718 fi
719 }
720
Gilles Peskine7c652162017-12-11 00:01:40 +0100721 final_report () {
722 if [ $failure_count -gt 0 ]; then
723 echo
724 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100725 echo "${start_red}FAILED: $failure_count components${end_color}"
726 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100727 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
728 elif [ -z "${1-}" ]; then
729 echo "SUCCESS :)"
730 fi
731 if [ -n "${1-}" ]; then
732 echo "Killed by SIG$1."
733 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100734 rm -f "$failure_summary_file"
735 if [ $failure_count -gt 0 ]; then
736 exit 1
737 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100738 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100739}
740
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200741# record_status() and if_build_succeeded() are kept temporarily for backward
742# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100743record_status () {
744 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100745}
Gilles Peskine7c652162017-12-11 00:01:40 +0100746if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100747 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100748}
749
Gilles Peskinea681c592020-03-28 21:27:40 +0100750# '! true' does not trigger the ERR trap. Arrange to trigger it, with
751# a reasonably informative error message (not just "$@").
752not () {
753 if "$@"; then
754 report_failed_command="! $*"
755 false
756 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200757 fi
758}
759
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200760pre_prepare_outcome_file () {
761 case "$MBEDTLS_TEST_OUTCOME_FILE" in
762 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
763 esac
764 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
765 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
766 fi
767}
768
Gilles Peskine8f073122018-11-27 15:58:47 +0100769pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200770 if [ $QUIET -eq 1 ]; then
771 return
772 fi
773
Gilles Peskine8f073122018-11-27 15:58:47 +0100774 msg "info: $0 configuration"
775 echo "MEMORY: $MEMORY"
776 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200777 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100778 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100779 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100780 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100781 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
782 echo "GNUTLS_CLI: $GNUTLS_CLI"
783 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100784 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
785 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
786}
Andres AG7770ea82016-10-10 15:46:20 +0100787
Andres AGd9eba4b2016-08-26 14:42:14 +0100788# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100789pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000790 # Build the list of variables to pass to output_env.sh.
791 set env
SimonB2e23c822016-04-16 21:54:39 +0100792
Gilles Peskine87964262019-01-06 22:40:00 +0000793 case " $RUN_COMPONENTS " in
794 # Require OpenSSL and GnuTLS if running any tests (as opposed to
795 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
796 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100797 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000798 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
799 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100800 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000801 export GNUTLS_CLI="$GNUTLS_CLI"
802 export GNUTLS_SERV="$GNUTLS_SERV"
803 # Avoid passing --seed flag in every call to ssl-opt.sh
804 if [ -n "${SEED-}" ]; then
805 export SEED
806 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200807 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000808 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200809 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
810 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000811 ;;
812 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200813
Gilles Peskine87964262019-01-06 22:40:00 +0000814 case " $RUN_COMPONENTS " in
815 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
816 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100817
Gilles Peskine87964262019-01-06 22:40:00 +0000818 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200819 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000820 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100821
Gilles Peskine87964262019-01-06 22:40:00 +0000822 case " $RUN_COMPONENTS " in
823 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
824 esac
825
826 case " $RUN_COMPONENTS " in
827 *" test_zeroize "*) check_tools "gdb";;
828 esac
829
830 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000831 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000832 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
833 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200834 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000835 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
836 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200837 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
838 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
839 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000840 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000841
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200842 # past this point, no call to check_tool, only printing output
843 if [ $QUIET -eq 1 ]; then
844 return
845 fi
846
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000847 msg "info: output_env.sh"
848 case $RUN_COMPONENTS in
849 *_armcc*)
850 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
851 *) set "$@" RUN_ARMCC=0;;
852 esac
853 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100854}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100855
Gilles Peskine1570b592021-04-22 01:10:12 +0200856pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200857 # since make doesn't have proper dependencies, remove any possibly outdate
858 # file that might be around before generating fresh ones
859 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200860 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200861 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200862 else
863 make generated_files
864 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200865}
866
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000867clang_version() {
868 if command -v clang > /dev/null ; then
869 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
870 else
871 echo 0 # report version 0 for "no clang"
872 fi
873}
874
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200875################################################################
876#### Helpers for components using libtestdriver1
877################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100878
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200879# How to use libtestdriver1
880# -------------------------
881#
882# 1. Define the list algorithms and key types to accelerate,
883# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
884# Examples:
885# - loc_accel_list="ALG_JPAKE"
886# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200887# 2. Make configurations changes for the driver and/or main libraries.
888# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
889# can be either "default" to start with the default config, or a name
890# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200891# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200892# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
893# These changes affect both the driver and the main libraries.
894# (Note: they need to have the same set of PSA_WANT symbols, as that
895# determines the ABI between them.)
896# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
897# main libraries. Typically, you want to disable the module(s) that are
898# being accelerated. You may need to also disable modules that depend
899# on them or options that are not supported with drivers.
900# 2d. On top of psa/crypto_config.h, the driver library uses its own config
901# file: tests/include/test/drivers/config_test_driver.h. You usually
902# don't need to edit it: using loc_extra_list (see below) is preferred.
903# However, when there's no PSA symbol for what you want to enable,
904# calling scripts/config.py on this file remains the only option.
905# 3. Build the driver library, then the main libraries, test, and programs.
906# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
907# need to enable more algorithms here, typically hash algorithms when
908# accelerating some signature algorithms (ECDSA, RSAv2). This is done
909# by passing a 2nd argument listing the extra algorithms.
910# Example:
911# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
912# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800913# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200914# additional arguments will be passed to make: this can be useful if
915# you don't want to build everything when iterating during development.
916# Example:
917# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
918# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200919
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200920# Adjust the configuration - for both libtestdriver1 and main library,
921# as they should have the same PSA_WANT macros.
922helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200923 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200924 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200925 if [ "$base_config" != "default" ]; then
926 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200927 fi
928
929 # Enable PSA-based config (necessary to use drivers)
930 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
931
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200932 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
933 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
934 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000935
936 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
937 # otherwise we will end up running multithreaded tests without mutexes to protect them.
938 if scripts/config.py get MBEDTLS_THREADING_C; then
939 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
940 fi
941
942 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
943 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
944 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200945}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100946
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100947# Build the drivers library libtestdriver1.a (with ASan).
948#
949# Parameters:
950# 1. a space-separated list of things to accelerate;
951# 2. optional: a space-separate list of things to also support.
952# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
953helper_libtestdriver1_make_drivers() {
954 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
955 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
956}
957
958# Build the main libraries, programs and tests,
959# linking to the drivers library (with ASan).
960#
961# Parameters:
962# 1. a space-separated list of things to accelerate;
963# *. remaining arguments if any are passed directly to make
964# (examples: lib, -C tests test_suite_xxx, etc.)
965# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
966helper_libtestdriver1_make_main() {
967 loc_accel_list=$1
968 shift
969
970 # we need flags both with and without the LIBTESTDRIVER1_ prefix
971 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
972 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
973 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" "$@"
974}
975
Valerio Setti9022f712024-06-27 07:59:39 +0200976# Set some default values $CONFIG_H in order to build server or client sides
977# in PSASIM. There is only 1 mandatory parameter:
978# - $1: target which can be "client" or "server"
Valerio Settid8b59372024-07-02 12:02:25 +0200979helper_psasim_config() {
Valerio Settid1b6ef12024-05-07 16:00:21 +0200980 TARGET=$1
Valerio Settid1b6ef12024-05-07 16:00:21 +0200981
Valerio Settid1b6ef12024-05-07 16:00:21 +0200982 if [ "$TARGET" == "client" ]; then
983 scripts/config.py full
984 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
985 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
986 # Dynamic secure element support is a deprecated feature and it is not
987 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
988 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
989 # Disable potentially problematic features
990 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
991 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
992 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
993 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
994 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100995 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200996 else
997 scripts/config.py crypto_full
998 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100999 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
1000 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1001 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
1002 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +02001003 fi
Valerio Setti9022f712024-06-27 07:59:39 +02001004}
Valerio Settid1b6ef12024-05-07 16:00:21 +02001005
Valerio Setti9022f712024-06-27 07:59:39 +02001006# Helper to build the libraries for client/server in PSASIM. If the server is
1007# being built, then it builds also the final executable.
1008# There is only 1 mandatory parameter:
1009# - $1: target which can be "client" or "server"
1010helper_psasim_build() {
1011 TARGET=$1
1012 shift
1013 TARGET_LIB=${TARGET}_libs
1014
1015 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
1016
1017 # Build also the server application after its libraries have been built.
1018 if [ "$TARGET" == "server" ]; then
1019 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_server
1020 fi
Valerio Settid1b6ef12024-05-07 16:00:21 +02001021}
1022
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +01001023################################################################
1024#### Configuration helpers
1025################################################################
1026
Valerio Settib2fd6732023-08-15 17:10:47 +02001027# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +02001028# The function optionally accepts 1 parameter: a space-separated list of the
1029# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +02001030helper_disable_builtin_curves() {
1031 allowed_list="${1:-}"
1032 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
1033
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001034 for curve in $allowed_list; do
1035 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001036 done
1037}
1038
1039# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1040# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1041# in the following helpers.
1042helper_get_psa_curve_list () {
1043 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001044 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1045 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001046 done
1047
1048 echo "$loc_list"
1049}
1050
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001051# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1052# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1053# in the following helpers.
1054helper_get_psa_dh_group_list () {
1055 loc_list=""
1056 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1057 loc_list="$loc_list $item"
1058 done
1059
1060 echo "$loc_list"
1061}
1062
Valerio Settib2fd6732023-08-15 17:10:47 +02001063# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001064# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001065# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001066helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001067 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001068 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001069 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 +02001070 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1071 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001072 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1073 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001074 fi
1075 done
1076
1077 echo "$loc_list"
1078}
1079
Valerio Setti9022f712024-06-27 07:59:39 +02001080# Helper function for controlling (start & stop) the psasim server.
1081helper_psasim_server() {
1082 OPERATION=$1
1083 if [ "$OPERATION" == "start" ]; then
1084 (
1085 cd tests
1086 msg "start server"
1087 psa-client-server/psasim/test/start_server.sh
1088 )
1089 else
1090 (
1091 cd tests
1092 msg "terminate server and cleanup"
1093 psa-client-server/psasim//test/kill_server.sh
1094 )
1095 fi
1096}
1097
Gilles Peskine192c72f2017-12-21 15:59:21 +01001098################################################################
1099#### Basic checks
1100################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001101
Ronald Cron5b41a652024-07-03 08:59:47 +02001102export PSA_CORE_PATH="tf-psa-crypto/core"
Ronald Cron709bbf02024-07-03 07:59:30 +02001103export BUILTIN_SRC_PATH="tf-psa-crypto/drivers/builtin/src"
1104
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001105#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001106# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001107#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001108# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001109# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001110# 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 +02001111# time, so start with a GCC build).
1112# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001113#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001114# Indicative running times are given for reference.
1115
Gilles Peskine8f073122018-11-27 15:58:47 +01001116component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001117 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001118 tests/scripts/recursion.pl library/*.c
Ronald Cron5b41a652024-07-03 08:59:47 +02001119 tests/scripts/recursion.pl ${PSA_CORE_PATH}/*.c
Ronald Cron709bbf02024-07-03 07:59:30 +02001120 tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001121}
Janos Follathb72c6782016-07-19 14:54:17 +01001122
Gilles Peskine67debb62021-05-18 16:09:50 +02001123component_check_generated_files () {
1124 msg "Check: check-generated-files, files generated with make" # 2s
1125 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001126 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001127
1128 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001129 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001130 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001131 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001132
1133 msg "Check: check-generated-files -u, files absent" # 2s
1134 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001135 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001136 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001137 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001138
1139 # This component ends with the generated files present in the source tree.
1140 # This is necessary for subsequent components!
1141}
1142
Gilles Peskine8f073122018-11-27 15:58:47 +01001143component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001144 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001145 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001146}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001147
Gilles Peskine8f073122018-11-27 15:58:47 +01001148component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001149 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001150 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001151}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001152
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001153component_check_changelog () {
1154 msg "Check: changelog entries" # < 1s
1155 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001156 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001157 if [ -e ChangeLog.new ]; then
1158 # Show the diff for information. It isn't an error if the diff is
1159 # non-empty.
1160 diff -u ChangeLog ChangeLog.new || true
1161 rm ChangeLog.new
1162 fi
1163}
1164
Gilles Peskine8f073122018-11-27 15:58:47 +01001165component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001166 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001167 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001168}
Darryl Greena07039c2018-03-13 16:48:16 +00001169
Gilles Peskine895868b2019-09-19 21:30:05 +02001170component_check_test_cases () {
1171 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001172 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001173 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001174 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001175 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001176 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001177 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001178 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001179}
1180
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001181component_check_test_dependencies () {
1182 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001183 # The purpose of this component is to catch unjustified dependencies on
1184 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1185 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1186 # MBEDTLS_PSA_xxx).
1187 #
1188 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1189 # this component is meant to catch. However a few of them are justified,
1190 # mostly by the absence of a PSA equivalent, so this component includes a
1191 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001192
1193 found="check-test-deps-found-$$"
1194 expected="check-test-deps-expected-$$"
1195
1196 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001197 grep 'depends_on' \
1198 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001199 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001200 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001201 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001202
Yanray Wang18040ed2023-11-23 21:29:56 +08001203 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001204 rm -f $expected
1205 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1206 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001207 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1208 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001209 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1210 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001211 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1212 # the test code and that's probably the most convenient way of achieving
1213 # the test's goal.
1214 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1215 # No PSA equivalent - we should probably have one in the future.
1216 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1217 # No PSA equivalent - needed by some init tests
1218 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001219 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001220 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001221
1222 # Compare reality with expectation.
1223 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001224 #
1225 # The output should be empty. When it's not:
1226 # - Each '+' line is a macro that was found but not expected. You want to
1227 # find where that macro occurs, and either replace it with PSA macros, or
1228 # add it to the exceptions list above with a justification.
1229 # - Each '-' line is a macro that was expected but not found; it means the
1230 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001231 diff -U0 $expected $found
1232
1233 rm $found $expected
1234}
1235
Gilles Peskine8f073122018-11-27 15:58:47 +01001236component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001237 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001238 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001239}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001240
Gilles Peskine192c72f2017-12-21 15:59:21 +01001241
Gilles Peskine636c26a2020-03-04 20:46:15 +01001242
Gilles Peskine192c72f2017-12-21 15:59:21 +01001243################################################################
1244#### Build and test many configurations and targets
1245################################################################
1246
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001247component_test_default_out_of_box () {
1248 msg "build: make, default config (out-of-box)" # ~1min
1249 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001250 # Disable fancy stuff
1251 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001252
1253 msg "test: main suites make, default config (out-of-box)" # ~10s
1254 make test
1255
1256 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001257 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001258
1259 msg "program demos: make, default config (out-of-box)" # ~10s
1260 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001261}
1262
Gilles Peskine8f073122018-11-27 15:58:47 +01001263component_test_default_cmake_gcc_asan () {
1264 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001265 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1266 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001267
Gilles Peskine8f073122018-11-27 15:58:47 +01001268 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1269 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001270
Gilles Peskine82b27272019-06-14 18:27:03 +02001271 msg "program demos (ASan build)" # ~10s
1272 tests/scripts/run_demos.py
1273
Gilles Peskine97bea012020-04-23 23:37:45 +02001274 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001275 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001276
Gilles Peskine6848d172023-11-02 19:58:03 +01001277 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001278 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001279
Gilles Peskine8f073122018-11-27 15:58:47 +01001280 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001281 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001282
Gilles Peskine8f073122018-11-27 15:58:47 +01001283 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001284 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001285
1286 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001287 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001288}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001289
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001290component_test_default_cmake_gcc_asan_new_bignum () {
1291 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001292 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001293 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001294 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001295
1296 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1297 make test
1298
1299 msg "test: selftest (ASan build)" # ~ 10s
1300 programs/test/selftest
1301
1302 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1303 tests/ssl-opt.sh
1304
1305 msg "test: compat.sh (ASan build)" # ~ 6 min
1306 tests/compat.sh
1307
1308 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1309 tests/context-info.sh
1310}
1311
Hanno Becker01635512019-02-26 14:27:09 +00001312component_test_full_cmake_gcc_asan () {
1313 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001314 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001315 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1316 make
1317
1318 msg "test: main suites (inc. selftests) (full config, ASan build)"
1319 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001320
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001321 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001322 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001323
Gilles Peskine636c26a2020-03-04 20:46:15 +01001324 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001325 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001326
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001327 # Note: the next two invocations cover all compat.sh test cases.
1328 # We should use the same here and in basic-build-test.sh.
1329 msg "test: compat.sh: default version (full config, ASan build)"
1330 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001331
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001332 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1333 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001334
1335 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001336 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001337}
1338
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001339
1340component_test_full_cmake_gcc_asan_new_bignum () {
1341 msg "build: full config, cmake, gcc, ASan"
1342 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001343 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001344 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001345 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001346
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001347 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001348 make test
1349
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001350 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001351 programs/test/selftest
1352
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001353 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001354 tests/ssl-opt.sh
1355
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001356 # Note: the next two invocations cover all compat.sh test cases.
1357 # We should use the same here and in basic-build-test.sh.
1358 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1359 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001360
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001361 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1362 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001363
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001364 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001365 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001366}
1367
Ronald Cronc3623db2020-10-29 10:51:32 +01001368component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001369 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001370 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001371 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1372 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1373 make
1374
1375 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1376 make test
1377}
1378
David Horstmann4a48bec2024-03-13 15:42:31 +00001379component_test_psa_assume_exclusive_buffers () {
1380 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001381 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001382 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001383 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1384 make
1385
David Horstmann4a48bec2024-03-13 15:42:31 +00001386 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001387 make test
1388}
1389
Gilles Peskinea3548672021-06-17 11:37:52 +02001390# check_renamed_symbols HEADER LIB
1391# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1392# name is LIB.
1393check_renamed_symbols () {
1394 ! nm "$2" | sed 's/.* //' |
1395 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1396}
1397
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001398component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001399 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001400 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001401 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1402 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1403 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1404 # We can only compile, not link, since our test and sample programs
1405 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1406 # is active.
1407 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001408
1409 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1410 # version is not present.
1411 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001412 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001413}
1414
Ryan Everettdaa322a2024-04-18 16:48:55 +01001415component_test_no_rsa_key_pair_generation() {
1416 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001417 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001418 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001419 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001420 make
1421
Ryan Everettdaa322a2024-04-18 16:48:55 +01001422 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001423 make test
1424}
1425
Gilles Peskine782f4112018-11-27 16:11:09 +01001426component_test_ref_configs () {
1427 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001428 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1429 # want to re-generate generated files that depend on it, quite correctly.
1430 # However this doesn't work as the generation script expects a specific
1431 # format for mbedtls_config.h, which the other files don't follow. Also,
1432 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001433 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001434 # whether they're on or off. So, disable cmake's (over-sensitive here)
1435 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001436 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001437 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001438 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001439}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001440
Gilles Peskine8f073122018-11-27 15:58:47 +01001441component_test_no_renegotiation () {
1442 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001443 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001444 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001445 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001446
Gilles Peskine8f073122018-11-27 15:58:47 +01001447 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1448 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001449
Gilles Peskine8f073122018-11-27 15:58:47 +01001450 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001451 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001452}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001453
Gilles Peskine636c26a2020-03-04 20:46:15 +01001454component_test_no_pem_no_fs () {
1455 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1456 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1457 scripts/config.py unset MBEDTLS_FS_IO
1458 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1459 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001460 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001461 make
1462
1463 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1464 make test
1465
1466 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001467 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001468}
1469
Gilles Peskine8f073122018-11-27 15:58:47 +01001470component_test_rsa_no_crt () {
1471 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001472 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001473 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001474 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1477 make test
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 ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001480 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001481
Gilles Peskine8f073122018-11-27 15:58:47 +01001482 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001483 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001484
1485 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001486 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001487}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001488
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001489component_test_no_ctr_drbg_classic () {
1490 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001491 scripts/config.py full
1492 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001493 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001494 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001495
Dave Rodgman17127e92023-12-14 16:42:48 +00001496 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497 make
1498
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001499 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001500 make test
1501
Gilles Peskineba749042021-01-13 20:02:03 +01001502 # In this configuration, the TLS test programs use HMAC_DRBG.
1503 # The SSL tests are slow, so run a small subset, just enough to get
1504 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001505 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001506 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001507
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001508 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001509 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001510}
1511
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512component_test_no_ctr_drbg_use_psa () {
1513 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001514 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001515 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1516 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001517
Dave Rodgman17127e92023-12-14 16:42:48 +00001518 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001519 make
1520
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001521 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1522 make test
1523
1524 # In this configuration, the TLS test programs use HMAC_DRBG.
1525 # The SSL tests are slow, so run a small subset, just enough to get
1526 # confidence that the SSL code copes with HMAC_DRBG.
1527 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001528 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001529
1530 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001531 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001532}
1533
1534component_test_no_hmac_drbg_classic () {
1535 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1536 scripts/config.py full
1537 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1538 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1539 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001540 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001541
Dave Rodgman17127e92023-12-14 16:42:48 +00001542 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001543 make
1544
1545 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001546 make test
1547
Gilles Peskinea2224342020-11-19 22:14:34 +01001548 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1549 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1550 # instead.
1551 # Test SSL with non-deterministic ECDSA. Only test features that
1552 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001553 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001554 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001555
1556 # To save time, only test one protocol version, since this part of
1557 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001558 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001559 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001560}
1561
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001562component_test_no_hmac_drbg_use_psa () {
1563 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1564 scripts/config.py full
1565 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1566 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1567 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1568
Dave Rodgman17127e92023-12-14 16:42:48 +00001569 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001570 make
1571
1572 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1573 make test
1574
1575 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1576 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1577 # instead.
1578 # Test SSL with non-deterministic ECDSA. Only test features that
1579 # might be affected by how ECDSA signature is performed.
1580 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001581 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001582
1583 # To save time, only test one protocol version, since this part of
1584 # the protocol is identical in (D)TLS up to 1.2.
1585 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001586 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001587}
1588
1589component_test_psa_external_rng_no_drbg_classic () {
1590 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1591 scripts/config.py full
1592 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001593 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001594 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001595 scripts/config.py unset MBEDTLS_ENTROPY_C
1596 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1597 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001598 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1599 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1600 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001601 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1602 # the SSL test programs don't have an RNG and can't work. Explicitly
1603 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001604 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001605
1606 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1607 make test
1608
Gilles Peskine8eb29432021-02-03 20:07:11 +01001609 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001610 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001611}
1612
1613component_test_psa_external_rng_no_drbg_use_psa () {
1614 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001615 scripts/config.py full
1616 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001617 scripts/config.py unset MBEDTLS_ENTROPY_C
1618 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1619 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001620 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1621 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1622 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001623 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001624
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001625 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001626 make test
1627
Gilles Peskine8eb29432021-02-03 20:07:11 +01001628 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001629 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001630}
1631
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001632component_test_psa_external_rng_use_psa_crypto () {
1633 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1634 scripts/config.py full
1635 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1636 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1637 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001638 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001639
1640 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1641 make test
1642
1643 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1644 tests/ssl-opt.sh -f 'Default\|opaque'
1645}
1646
Gilles Peskine801c4332023-04-28 21:04:28 +02001647component_test_psa_inject_entropy () {
1648 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1649 scripts/config.py full
1650 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1651 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1652 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1653 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1654 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1655 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001656 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 +02001657
1658 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1659 make test
1660}
1661
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001662component_test_sw_inet_pton () {
1663 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1664
1665 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1666 scripts/config.py set MBEDTLS_TEST_HOOKS
1667 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1668
1669 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1670 make test
1671}
1672
Valerio Settia41654d2024-02-08 10:33:11 +01001673component_full_no_pkparse_pkwrite() {
1674 msg "build: full without pkparse and pkwrite"
1675
1676 scripts/config.py crypto_full
1677 scripts/config.py unset MBEDTLS_PK_PARSE_C
1678 scripts/config.py unset MBEDTLS_PK_WRITE_C
1679
Valerio Settia41654d2024-02-08 10:33:11 +01001680 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1681
1682 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
Ronald Cron709bbf02024-07-03 07:59:30 +02001683 not grep mbedtls_pk_parse_key ${BUILTIN_SRC_PATH}/pkparse.o
1684 not grep mbedtls_pk_write_key_der ${BUILTIN_SRC_PATH}/pkwrite.o
Valerio Settia41654d2024-02-08 10:33:11 +01001685
1686 msg "test: full without pkparse and pkwrite"
1687 make test
1688}
1689
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001690component_test_crypto_full_md_light_only () {
1691 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001692 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001693
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001694 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001695 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001696 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001697 scripts/config.py unset MBEDTLS_HKDF_C
1698 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001699 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001700 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001701 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001702 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001703 # Disable things that would auto-enable MD_C
1704 scripts/config.py unset MBEDTLS_PKCS5_C
1705
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001706 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1707 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001708 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001709
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001710 # Make sure we don't have the HMAC functions, but the hashing functions
Ronald Cron709bbf02024-07-03 07:59:30 +02001711 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1712 grep mbedtls_md ${BUILTIN_SRC_PATH}/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001713
1714 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001715 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001716}
1717
Ronald Cron8dbea482024-05-23 16:04:11 +02001718component_test_full_no_cipher () {
1719 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001720
1721 scripts/config.py full
1722 scripts/config.py unset MBEDTLS_CIPHER_C
1723
Ronald Cron8dbea482024-05-23 16:04:11 +02001724 # The built-in implementation of the following algs/key-types depends
1725 # on CIPHER_C so we disable them.
1726 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1727 # so we keep them enabled.
1728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1729 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1730 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1731 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1732 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1733 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1734 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1735 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1736 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1737 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1738 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1739
Valerio Settic84d9402023-10-23 14:58:25 +02001740 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001741 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001742 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001743
Gilles Peskine21570cf2023-12-22 11:49:50 +01001744 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001745
Valerio Setti7e710e82023-08-25 09:14:15 +02001746 # Ensure that CIPHER_C was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02001747 not grep mbedtls_cipher_init ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti7e710e82023-08-25 09:14:15 +02001748
Ronald Cron8dbea482024-05-23 16:04:11 +02001749 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001750 make test
1751}
1752
Valerio Settibdfecb62023-11-07 15:37:20 +01001753component_test_full_no_ccm() {
1754 msg "build: full no PSA_WANT_ALG_CCM"
1755
1756 # Full config enables:
1757 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1758 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1759 scripts/config.py full
1760
1761 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1762 # enabled, but not used from TLS since USE_PSA is set.
1763 # This is helpful to ensure that TLS tests below have proper dependencies.
1764 #
1765 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1766 # PSA_WANT_ALG_CCM to be re-enabled.
1767 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1768
Gilles Peskine21570cf2023-12-22 11:49:50 +01001769 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001770
1771 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001772 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001773}
1774
1775component_test_full_no_ccm_star_no_tag() {
1776 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1777
1778 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1779 scripts/config.py full
1780
1781 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1782 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1783 # This basically disables all unauthenticated ciphers on the PSA side, while
1784 # keeping AEADs enabled.
1785 #
1786 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1787 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1788 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1789 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1790 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1791 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1792 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1793 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1794 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1795 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1796
Gilles Peskine21570cf2023-12-22 11:49:50 +01001797 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001798
1799 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Ronald Cron5b41a652024-07-03 08:59:47 +02001800 not grep mbedtls_psa_cipher ${PSA_CORE_PATH}/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001801
1802 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001803 make test
1804}
1805
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001806component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001807 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001808
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001809 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001810 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001811 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001812 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001813 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001814 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1815 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001816 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001817 scripts/config.py unset MBEDTLS_GCM_C
1818 scripts/config.py unset MBEDTLS_CCM_C
1819 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001820 #Disable TLS 1.3 (as no AEAD)
1821 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001822 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1823 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1824 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001825 # 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 +01001826 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001827 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001828 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001829 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001830 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1831 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001832 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001833 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001834 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001835
Przemek Stekiel9550c052022-09-28 09:51:55 +02001836 make
1837
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001838 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001839 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001840
1841 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001842}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001843
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001844component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001845 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001846
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001847 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001848 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001849 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001850 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001851 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001852 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1853 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001854 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001855 scripts/config.py unset MBEDTLS_GCM_C
1856 scripts/config.py unset MBEDTLS_CCM_C
1857 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001858 #Disable TLS 1.3 (as no AEAD)
1859 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001860 # 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 +01001861 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001862 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001863 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001864 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001865 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001866 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001867 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001868 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001869
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001870 make
1871
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001872 msg "test: default with only CBC-legacy cipher use psa"
1873 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001874
1875 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1876 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001877}
1878
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001879component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001880 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001881
1882 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001883 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001884 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001885 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001886 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001887 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1888 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001889 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001890 scripts/config.py unset MBEDTLS_GCM_C
1891 scripts/config.py unset MBEDTLS_CCM_C
1892 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001893 #Disable TLS 1.3 (as no AEAD)
1894 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001895 # 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 +01001896 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001897 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1898 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1899 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001900 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001901 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001902 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001903 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001904
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001905 make
1906
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001907 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001908 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001909
1910 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1911 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001912}
1913
Valerio Setti9f0ec532022-11-08 13:03:24 +01001914# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1915# that we could use for interop testing. However, we now have sort of two
1916# implementations ourselves: one using PSA, the other not. At least test that
1917# these two interoperate with each other.
1918component_test_tls1_2_ecjpake_compatibility() {
1919 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1920 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001921 # Explicitly make lib first to avoid a race condition:
1922 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1923 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001924 make -C programs ssl/ssl_server2 ssl/ssl_client2
1925 cp programs/ssl/ssl_server2 s2_no_use_psa
1926 cp programs/ssl/ssl_client2 c2_no_use_psa
1927
1928 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1929 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1930 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001931 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001932 make -C programs ssl/ssl_server2 ssl/ssl_client2
1933 make -C programs test/udp_proxy test/query_compile_time_config
1934
Valerio Setti70e02902022-12-02 16:21:56 +01001935 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1936 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1937 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1938 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1939 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1940 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1941 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1942 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 +01001943
1944 rm s2_no_use_psa c2_no_use_psa
1945}
1946
Gilles Peskine636c26a2020-03-04 20:46:15 +01001947component_test_everest () {
1948 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001949 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1950 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1951 make
1952
1953 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1954 make test
1955
Gilles Peskine6848d172023-11-02 19:58:03 +01001956 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001957 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001958
Gilles Peskine636c26a2020-03-04 20:46:15 +01001959 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001960 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001961
1962 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1963 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001964 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001965}
1966
Gilles Peskined3beca92020-07-03 00:15:37 +02001967component_test_everest_curve25519_only () {
1968 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001969 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02001970 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1971 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001972 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1973 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
1974 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02001975 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1976 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001977 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001978 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
1979
Gilles Peskined3beca92020-07-03 00:15:37 +02001980 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001981 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001982 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
1983 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02001984
Dave Rodgman17127e92023-12-14 16:42:48 +00001985 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02001986
1987 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1988 make test
1989}
1990
Gilles Peskine8f073122018-11-27 15:58:47 +01001991component_test_small_ssl_out_content_len () {
1992 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001993 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1994 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00001995 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001996 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001997
Gilles Peskine8f073122018-11-27 15:58:47 +01001998 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001999 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002000}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002001
Gilles Peskine8f073122018-11-27 15:58:47 +01002002component_test_small_ssl_in_content_len () {
2003 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002004 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2005 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002006 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002007 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002008
Gilles Peskine8f073122018-11-27 15:58:47 +01002009 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002010 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002011}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002012
Gilles Peskine8f073122018-11-27 15:58:47 +01002013component_test_small_ssl_dtls_max_buffering () {
2014 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002015 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002016 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002017 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002018
Gilles Peskine8f073122018-11-27 15:58:47 +01002019 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002020 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 +01002021}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002022
Gilles Peskine8f073122018-11-27 15:58:47 +01002023component_test_small_mbedtls_ssl_dtls_max_buffering () {
2024 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002025 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002026 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002027 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002028
Gilles Peskine8f073122018-11-27 15:58:47 +01002029 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002030 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002031}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002032
Gilles Peskine75cc7712019-09-06 19:47:17 +02002033component_test_psa_collect_statuses () {
2034 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002035 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002036 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002037 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002038 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002039 rm -f tests/statuses.log
2040}
2041
Gilles Peskine8f073122018-11-27 15:58:47 +01002042component_test_full_cmake_clang () {
2043 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002044 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002045 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 +01002046 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002047
k-stachowiak0291cb72019-06-26 15:52:12 +02002048 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002049 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002050
Gilles Peskineda6017c2022-10-30 21:02:40 +01002051 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2052 programs/test/cpp_dummy_build
2053
Gilles Peskine6848d172023-11-02 19:58:03 +01002054 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002055 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002056
Gilles Peskine82b27272019-06-14 18:27:03 +02002057 msg "program demos (full config, clang)" # ~10s
2058 tests/scripts/run_demos.py
2059
k-stachowiak0291cb72019-06-26 15:52:12 +02002060 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002061 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002062
Gilles Peskine8f073122018-11-27 15:58:47 +01002063 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002064 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002065}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002066
Gilles Peskine0c671602022-11-29 16:01:41 +01002067skip_suites_without_constant_flow () {
2068 # Skip the test suites that don't have any constant-flow annotations.
2069 # This will need to be adjusted if we ever start declaring things as
2070 # secret from macros or functions inside tests/include or tests/src.
2071 SKIP_TEST_SUITES=$(
2072 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2073 sed 's/test_suite_//; s/\.function$//' |
2074 tr '\n' ,)
2075 export SKIP_TEST_SUITES
2076}
2077
Dave Rodgman246210e2023-07-31 18:07:44 +01002078skip_all_except_given_suite () {
2079 # Skip all but the given test suite
2080 SKIP_TEST_SUITES=$(
2081 ls -1 tests/suites/test_suite_*.function |
2082 grep -v $1.function |
2083 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2084 tr '\n' ,)
2085 export SKIP_TEST_SUITES
2086}
2087
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002088component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002089 # This tests both (1) accesses to undefined memory, and (2) branches or
2090 # memory access depending on secret values. To distinguish between those:
2091 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2092 # - or alternatively, change the build type to MemSanDbg, which enables
2093 # origin tracking and nicer stack traces (which are useful for debugging
2094 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002095 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2096 scripts/config.py full
2097 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2098 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2099 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2100 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2101 make
2102
2103 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2104 make test
2105}
2106
2107component_test_memsan_constant_flow_psa () {
2108 # This tests both (1) accesses to undefined memory, and (2) branches or
2109 # memory access depending on secret values. To distinguish between those:
2110 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2111 # - or alternatively, change the build type to MemSanDbg, which enables
2112 # origin tracking and nicer stack traces (which are useful for debugging
2113 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002114 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002115 scripts/config.py full
2116 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2117 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2118 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2119 make
2120
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002121 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002122 make test
2123}
2124
Bence Szépkúti0354d042023-12-06 16:14:37 +01002125component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002126 # This tests both (1) everything that valgrind's memcheck usually checks
2127 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2128 # etc.) and (2) branches or memory access depending on secret values,
2129 # which will be reported as uninitialized memory. To distinguish between
2130 # secret and actually uninitialized:
2131 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2132 # - or alternatively, build with debug info and manually run the offending
2133 # test suite with valgrind --track-origins=yes, then check if the origin
2134 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002135 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2136 scripts/config.py full
2137 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2138 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002139 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002140 cmake -D CMAKE_BUILD_TYPE:String=Release .
2141 make
2142
2143 # this only shows a summary of the results (how many of each type)
2144 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002145 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002146 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002147
2148 # Test asm path in constant time module - by default, it will test the plain C
2149 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2150 msg "test: valgrind asm constant_time"
2151 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2152 skip_all_except_given_suite test_suite_constant_time
2153 cmake -D CMAKE_BUILD_TYPE:String=Release .
2154 make clean
2155 make
2156 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002157}
2158
Bence Szépkúti0354d042023-12-06 16:14:37 +01002159component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002160 # This tests both (1) everything that valgrind's memcheck usually checks
2161 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2162 # etc.) and (2) branches or memory access depending on secret values,
2163 # which will be reported as uninitialized memory. To distinguish between
2164 # secret and actually uninitialized:
2165 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2166 # - or alternatively, build with debug info and manually run the offending
2167 # test suite with valgrind --track-origins=yes, then check if the origin
2168 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002169 msg "build: cmake release GCC, full config with constant flow testing"
2170 scripts/config.py full
2171 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002172 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002173 cmake -D CMAKE_BUILD_TYPE:String=Release .
2174 make
2175
2176 # this only shows a summary of the results (how many of each type)
2177 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002178 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002179 make memcheck
2180}
2181
Janos Follath9338cac2023-10-04 18:55:39 +01002182component_test_tsan () {
2183 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002184 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002185 scripts/config.py set MBEDTLS_THREADING_C
2186 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002187 # Self-tests do not currently use multiple threads.
2188 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002189
Ryan6caf84f2024-03-05 13:57:00 +00002190 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2191 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2192
Janos Follath9338cac2023-10-04 18:55:39 +01002193 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2194 make
2195
2196 msg "test: main suites (TSan)"
2197 make test
2198}
2199
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002200component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002201 # Test that removing the deprecated features from the default
2202 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002203 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2204 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002205 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002206
2207 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2208 make test
2209}
2210
2211component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002212 msg "build: make, full_no_deprecated config" # ~ 30s
2213 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002214 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002215
Gilles Peskine30de2e82020-04-20 21:39:22 +02002216 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002217 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002218
2219 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2220 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002221}
2222
Gilles Peskine8386ea22020-04-30 09:07:29 +02002223component_test_full_no_deprecated_deprecated_warning () {
2224 # Test that there is nothing deprecated in "full_no_deprecated".
2225 # A deprecated feature would trigger a warning (made fatal) from
2226 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002227 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2228 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002229 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2230 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002231 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002232
Gilles Peskine30de2e82020-04-20 21:39:22 +02002233 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002234 make test
2235}
2236
Gilles Peskine8386ea22020-04-30 09:07:29 +02002237component_test_full_deprecated_warning () {
2238 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2239 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002240 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002241 scripts/config.py full
2242 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002243 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002244 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2245 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002246 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002247
Gilles Peskine8386ea22020-04-30 09:07:29 +02002248 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2249 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2250 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002251 # Expect warnings from '#warning' directives in check_config.h and
2252 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002253 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 +01002254
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002255 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2256 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002257
2258 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2259 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002260}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002261
Gilles Peskineec541fe2020-01-31 14:24:14 +01002262# Check that the specified libraries exist and are empty.
2263are_empty_libraries () {
2264 nm "$@" >/dev/null 2>/dev/null
2265 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2266}
2267
2268component_build_crypto_default () {
2269 msg "build: make, crypto only"
2270 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002271 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002272 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002273}
2274
2275component_build_crypto_full () {
2276 msg "build: make, crypto only, full config"
2277 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002278 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002279 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002280}
2281
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002282component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002283 msg "build: make, config for PSA crypto service"
2284 scripts/config.py crypto
2285 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2286 # Disable things that are not needed for just cryptography, to
2287 # reach a configuration that would be typical for a PSA cryptography
2288 # service providing all implemented PSA algorithms.
2289 # System stuff
2290 scripts/config.py unset MBEDTLS_ERROR_C
2291 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002292 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002293 # Crypto stuff with no PSA interface
2294 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002295 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002296 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002297 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002298 scripts/config.py unset MBEDTLS_NIST_KW_C
2299 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2300 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2301 scripts/config.py unset MBEDTLS_PKCS12_C
2302 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002303 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2304 # in PSA code to work with RSA keys. We don't require users to set those:
2305 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002306 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002307 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002308 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002309 make CFLAGS='-O1 -Werror' all test
2310 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2311}
2312
Gilles Peskineec541fe2020-01-31 14:24:14 +01002313component_build_crypto_baremetal () {
2314 msg "build: make, crypto only, baremetal config"
2315 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002316 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002317 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002318}
Daniel Axtens446af202020-09-02 21:30:13 +10002319support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002320 support_build_baremetal "$@"
2321}
2322
2323component_build_baremetal () {
2324 msg "build: make, baremetal config"
2325 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002326 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002327}
2328support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002329 # Older Glibc versions include time.h from other headers such as stdlib.h,
2330 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2331 # problem, Ubuntu 18.04 is ok.
2332 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2333}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002334
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002335# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002336component_test_depends_py_cipher_id () {
2337 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002338 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002339}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002340
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002341component_test_depends_py_cipher_chaining () {
2342 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002343 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002344}
2345
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002346component_test_depends_py_cipher_padding () {
2347 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002348 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002349}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002350
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002351component_test_depends_py_curves () {
2352 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002353 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002354}
2355
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002356component_test_depends_py_hashes () {
2357 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002358 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002359}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002360
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002361component_test_depends_py_kex () {
2362 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002363 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002364}
2365
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002366component_test_depends_py_pkalgs () {
2367 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002368 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002369}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002370
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002371# PSA equivalents of the depends.py tests
2372component_test_depends_py_cipher_id_psa () {
2373 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002374 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002375}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002376
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002377component_test_depends_py_cipher_chaining_psa () {
2378 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002379 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002380}
2381
2382component_test_depends_py_cipher_padding_psa () {
2383 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002384 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002385}
2386
2387component_test_depends_py_curves_psa () {
2388 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002389 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002390}
2391
2392component_test_depends_py_hashes_psa () {
2393 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002394 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002395}
2396
2397component_test_depends_py_kex_psa () {
2398 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002399 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002400}
2401
2402component_test_depends_py_pkalgs_psa () {
2403 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002404 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002405}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002406
Valerio Setti6bed64e2024-01-17 15:21:44 +01002407component_test_psa_crypto_config_ffdh_2048_only () {
2408 msg "build: full config - only DH 2048"
2409
2410 scripts/config.py full
2411
2412 # Disable all DH groups other than 2048.
2413 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2414 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2415 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2416 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2417
2418 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2419
2420 msg "test: full config - only DH 2048"
2421 make test
2422
2423 msg "ssl-opt: full config - only DH 2048"
2424 tests/ssl-opt.sh -f "ffdh"
2425}
2426
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002427component_build_no_pk_rsa_alt_support () {
2428 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2429
2430 scripts/config.py full
2431 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2432 scripts/config.py set MBEDTLS_RSA_C
2433 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2434
2435 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002436 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002437}
2438
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002439component_build_module_alt () {
2440 msg "build: MBEDTLS_XXX_ALT" # ~30s
2441 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002442
2443 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002444 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002445 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002446 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002447 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2448 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002449 # You can only have one threading implementation: alt or pthread, not both.
2450 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002451 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2452 # directly and assumes the implementation works with partial groups.
2453 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002454 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2455 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2456 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002457 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2458 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2459 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002460
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002461 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2462 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2463 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002464
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002465 # We can only compile, not link, since we don't have any implementations
2466 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002467 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002468}
2469
Gilles Peskine64996c32024-01-23 20:25:47 +01002470component_test_no_psa_crypto_full_cmake_asan() {
2471 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2472 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002473 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002474 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002475 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002476 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002477 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002478 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002479 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002480 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002481 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002482 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002483 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002484 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002485
Gilles Peskine64996c32024-01-23 20:25:47 +01002486 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002487 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002488
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002489 # Note: ssl-opt.sh has some test cases that depend on
2490 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2491 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002492 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002493 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002494
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002495 # Note: the next two invocations cover all compat.sh test cases.
2496 # We should use the same here and in basic-build-test.sh.
2497 msg "test: compat.sh: default version (full minus PSA crypto)"
2498 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002499
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002500 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002501 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002502}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002503
Ronald Cron403c15c2021-09-13 09:38:05 +02002504component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002505 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002506
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002507 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002508 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002509 $(helper_get_psa_key_type_list "ECC") \
2510 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002511
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002512 # Configure
2513 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002514
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002515 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002516 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002517
2518 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002519 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002520
2521 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002522 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2523 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2524
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002525 # Build
2526 # -----
2527
2528 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002529 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2530 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002531
2532 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2533
Valerio Setti3fe105b2023-10-30 11:08:12 +01002534 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002535
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002536 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002537 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002538
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002539 # Run the tests
2540 # -------------
2541
Ronald Cron403c15c2021-09-13 09:38:05 +02002542 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2543 make test
2544}
2545
Valerio Setti44b178c2023-03-22 14:02:57 +01002546component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002547 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002548
2549 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002550 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002551 $(helper_get_psa_key_type_list "ECC") \
2552 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002553
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002554 # Configure
2555 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002556
Ronald Cron46ac0652024-03-18 12:39:04 +01002557 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002558 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002559
Valerio Setti44b178c2023-03-22 14:02:57 +01002560 # Disable the module that's accelerated
2561 scripts/config.py unset MBEDTLS_ECDH_C
2562
2563 # Disable things that depend on it
2564 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2565 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2566 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2567 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2568 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2569
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002570 # Build
2571 # -----
2572
2573 helper_libtestdriver1_make_drivers "$loc_accel_list"
2574
Valerio Setti3fe105b2023-10-30 11:08:12 +01002575 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002576
Valerio Setti44b178c2023-03-22 14:02:57 +01002577 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002578 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002579
2580 # Run the tests
2581 # -------------
2582
Valerio Setti44b178c2023-03-22 14:02:57 +01002583 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002584 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002585}
2586
Przemek Stekieldccb2022023-05-11 10:48:50 +02002587component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002588 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002589
2590 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002591 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002592 $(helper_get_psa_key_type_list "DH") \
2593 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002594
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002595 # Configure
2596 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002597
Przemek Stekiel565353e2023-07-05 11:07:07 +02002598 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002599 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002600
2601 # Disable the module that's accelerated
2602 scripts/config.py unset MBEDTLS_DHM_C
2603
2604 # Disable things that depend on it
2605 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2606 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2607
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002608 # Build
2609 # -----
2610
2611 helper_libtestdriver1_make_drivers "$loc_accel_list"
2612
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002613 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002614
2615 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002616 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Przemek Stekieldccb2022023-05-11 10:48:50 +02002617
2618 # Run the tests
2619 # -------------
2620
Gilles Peskine14302ed2023-07-19 19:30:04 +02002621 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002622 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002623
Gilles Peskine14302ed2023-07-19 19:30:04 +02002624 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002625 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002626}
2627
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002628component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002629 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002630
2631 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002632 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002633
2634 # Disable things that are not supported
2635 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2636 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002637 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002638
Gilles Peskine14302ed2023-07-19 19:30:04 +02002639 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002640 make test
2641
Gilles Peskine14302ed2023-07-19 19:30:04 +02002642 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002643 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002644}
2645
Valerio Setti44b178c2023-03-22 14:02:57 +01002646component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002647 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002648
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002649 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002650 $(helper_get_psa_key_type_list "ECC") \
2651 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002652
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002653 # Configure
2654 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002655
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002656 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002657
2658 # Make built-in fallback not available
2659 scripts/config.py unset MBEDTLS_ECJPAKE_C
2660 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2661
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002662 # Build
2663 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002664
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002665 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002666
Valerio Setti3fe105b2023-10-30 11:08:12 +01002667 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002668
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002669 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002670 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002671
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002672 # Run the tests
2673 # -------------
2674
Gilles Peskine14302ed2023-07-19 19:30:04 +02002675 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002676 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002677}
2678
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002679component_test_psa_crypto_config_accel_ecc_some_key_types () {
2680 msg "build: full with accelerated EC algs and some key types"
2681
2682 # Algorithms and key types to accelerate
2683 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2684 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2685 ALG_ECDH \
2686 ALG_JPAKE \
2687 KEY_TYPE_ECC_PUBLIC_KEY \
2688 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2689 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002690 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2691 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002692
2693 # Configure
2694 # ---------
2695
2696 # start with config full for maximum coverage (also enables USE_PSA)
2697 helper_libtestdriver1_adjust_config "full"
2698
2699 # Disable modules that are accelerated - some will be re-enabled
2700 scripts/config.py unset MBEDTLS_ECDSA_C
2701 scripts/config.py unset MBEDTLS_ECDH_C
2702 scripts/config.py unset MBEDTLS_ECJPAKE_C
2703 scripts/config.py unset MBEDTLS_ECP_C
2704
2705 # Disable all curves - those that aren't accelerated should be re-enabled
2706 helper_disable_builtin_curves
2707
2708 # Restartable feature is not yet supported by PSA. Once it will in
2709 # the future, the following line could be removed (see issues
2710 # 6061, 6332 and following ones)
2711 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2712
2713 # this is not supported by the driver API yet
2714 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2715
2716 # Build
2717 # -----
2718
2719 # These hashes are needed for some ECDSA signature tests.
2720 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2721 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2722 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2723
Valerio Setti3fe105b2023-10-30 11:08:12 +01002724 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002725
2726 # ECP should be re-enabled but not the others
Ronald Cron709bbf02024-07-03 07:59:30 +02002727 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2728 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2729 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
2730 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002731
2732 # Run the tests
2733 # -------------
2734
2735 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002736 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002737}
2738
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002739# Run tests with only (non-)Weierstrass accelerated
2740# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002741# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2742# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002743common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002744 weierstrass=$1
2745 if [ $weierstrass -eq 1 ]; then
2746 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002747 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002748 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002749 fi
2750
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002751 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002752
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002753 # Note: Curves are handled in a special way by the libtestdriver machinery,
2754 # so we only want to include them in the accel list when building the main
2755 # libraries, hence the use of a separate variable.
2756 # Note: the following loop is a modified version of
2757 # helper_get_psa_curve_list that only keeps Weierstrass families.
2758 loc_weierstrass_list=""
2759 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002760 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2761 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002762 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002763 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002764 ;;
2765 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002766 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002767 ;;
2768 esac
2769 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002770 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002771 loc_curve_list=$loc_weierstrass_list
2772 else
2773 loc_curve_list=$loc_non_weierstrass_list
2774 fi
2775
Valerio Setti3fe105b2023-10-30 11:08:12 +01002776 # Algorithms and key types to accelerate
2777 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2778 ALG_ECDH \
2779 ALG_JPAKE \
2780 $(helper_get_psa_key_type_list "ECC") \
2781 $loc_curve_list"
2782
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002783 # Configure
2784 # ---------
2785
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002786 # Start with config crypto_full and remove PK_C:
2787 # that's what's supported now, see docs/driver-only-builds.md.
2788 helper_libtestdriver1_adjust_config "crypto_full"
2789 scripts/config.py unset MBEDTLS_PK_C
2790 scripts/config.py unset MBEDTLS_PK_PARSE_C
2791 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002792
2793 # Disable modules that are accelerated - some will be re-enabled
2794 scripts/config.py unset MBEDTLS_ECDSA_C
2795 scripts/config.py unset MBEDTLS_ECDH_C
2796 scripts/config.py unset MBEDTLS_ECJPAKE_C
2797 scripts/config.py unset MBEDTLS_ECP_C
2798
2799 # Disable all curves - those that aren't accelerated should be re-enabled
2800 helper_disable_builtin_curves
2801
2802 # Restartable feature is not yet supported by PSA. Once it will in
2803 # the future, the following line could be removed (see issues
2804 # 6061, 6332 and following ones)
2805 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2806
2807 # this is not supported by the driver API yet
2808 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2809
2810 # Build
2811 # -----
2812
2813 # These hashes are needed for some ECDSA signature tests.
2814 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2815 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2816 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2817
Valerio Settiac7a8092023-10-31 12:23:44 +01002818 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002819
2820 # We expect ECDH to be re-enabled for the missing curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002821 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002822 # We expect ECP to be re-enabled, however the parts specific to the
2823 # families of curves that are accelerated should be ommited.
2824 # - functions with mxz in the name are specific to Montgomery curves
2825 # - ecp_muladd is specific to Weierstrass curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002826 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002827 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002828 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2829 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002830 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002831 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2832 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002833 fi
2834 # We expect ECDSA and ECJPAKE to be re-enabled only when
2835 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002836 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002837 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2838 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002839 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002840 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2841 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002842 fi
2843
2844 # Run the tests
2845 # -------------
2846
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002847 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2848 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002849}
2850
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002851component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002852 common_test_psa_crypto_config_accel_ecc_some_curves 1
2853}
2854
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002855component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002856 common_test_psa_crypto_config_accel_ecc_some_curves 0
2857}
2858
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002859# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2860# ECDH, ECDSA) with and without drivers.
2861# The input parameter is a boolean value which indicates:
2862# - 0 keep built-in EC algs,
2863# - 1 exclude built-in EC algs (driver only).
2864#
2865# This is used by the two following components to ensure they always use the
2866# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002867# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2868# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002869# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002870config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002871 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002872 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002873 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002874 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002875 # Disable modules that are accelerated
2876 scripts/config.py unset MBEDTLS_ECDSA_C
2877 scripts/config.py unset MBEDTLS_ECDH_C
2878 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002879 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002880 fi
2881
2882 # Restartable feature is not yet supported by PSA. Once it will in
2883 # the future, the following line could be removed (see issues
2884 # 6061, 6332 and following ones)
2885 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002886}
2887
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002888# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2889component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002890 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002891
2892 # Algorithms and key types to accelerate
2893 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2894 ALG_ECDH \
2895 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002896 $(helper_get_psa_key_type_list "ECC") \
2897 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002898
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002899 # Configure
2900 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002901
2902 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002903 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002904
Valerio Setti0a342c92023-09-01 09:12:31 +02002905 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002906 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2907 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002908
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002909 # Build
2910 # -----
2911
2912 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002913 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2914 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002915 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2916
Valerio Setti3fe105b2023-10-30 11:08:12 +01002917 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002918
2919 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002920 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
2921 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2922 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
2923 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002924
2925 # Run the tests
2926 # -------------
2927
Gilles Peskine14302ed2023-07-19 19:30:04 +02002928 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002929 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002930
Gilles Peskine14302ed2023-07-19 19:30:04 +02002931 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002932 tests/ssl-opt.sh
2933}
2934
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002935# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2936component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002937 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002938
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002939 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002940
Gilles Peskine21570cf2023-12-22 11:49:50 +01002941 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002942
Gilles Peskine14302ed2023-07-19 19:30:04 +02002943 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002944 make test
2945
Gilles Peskine14302ed2023-07-19 19:30:04 +02002946 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002947 tests/ssl-opt.sh
2948}
2949
Valerio Settie618cb02023-04-12 14:59:16 +02002950# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002951# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2952# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002953# to ensure that both tests use the same underlying configuration when testing
2954# driver's coverage with analyze_outcomes.py.
2955#
2956# This functions accepts 1 boolean parameter as follows:
2957# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2958# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2959# - 0: include built-in implementation of EC algorithms.
2960#
2961# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2962# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002963config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002964 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002965 # start with full config for maximum coverage (also enables USE_PSA)
2966 helper_libtestdriver1_adjust_config "full"
2967
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002968 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002969 # Disable modules that are accelerated
2970 scripts/config.py unset MBEDTLS_ECDSA_C
2971 scripts/config.py unset MBEDTLS_ECDH_C
2972 scripts/config.py unset MBEDTLS_ECJPAKE_C
2973 # Disable ECP module (entirely)
2974 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002975 fi
2976
Valerio Settiaecd32c2023-06-14 10:42:31 +02002977 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2978 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002979 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002980 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002981
Valerio Settie618cb02023-04-12 14:59:16 +02002982 # Restartable feature is not yet supported by PSA. Once it will in
2983 # the future, the following line could be removed (see issues
2984 # 6061, 6332 and following ones)
2985 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002986}
2987
2988# Build and test a configuration where driver accelerates all EC algs while
2989# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2990# side.
2991#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002992# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2993component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002994 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002995
2996 # Algorithms and key types to accelerate
2997 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2998 ALG_ECDH \
2999 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003000 $(helper_get_psa_key_type_list "ECC") \
3001 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003002
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003003 # Configure
3004 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003005
Valerio Settie618cb02023-04-12 14:59:16 +02003006 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003007 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003008 # Disable all the builtin curves. All the required algs are accelerated.
3009 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003010
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003011 # Build
3012 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003013
3014 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003015 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3016 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3017 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003018
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003019 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003020
Valerio Setti3fe105b2023-10-30 11:08:12 +01003021 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003022
3023 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003024 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3025 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3026 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003027 # Also ensure that ECP module was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003028 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003029
3030 # Run the tests
3031 # -------------
3032
Gilles Peskine14302ed2023-07-19 19:30:04 +02003033 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003034 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003035
Gilles Peskine14302ed2023-07-19 19:30:04 +02003036 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003037 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003038}
3039
3040# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003041# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003042# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003043component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003044 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003045
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003046 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003047
Gilles Peskine21570cf2023-12-22 11:49:50 +01003048 make
Valerio Settie618cb02023-04-12 14:59:16 +02003049
Gilles Peskine14302ed2023-07-19 19:30:04 +02003050 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003051 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003052
Gilles Peskine14302ed2023-07-19 19:30:04 +02003053 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003054 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003055}
3056
Valerio Setti4e2f2442023-08-15 10:10:26 +02003057# This is a common configuration helper used directly from:
3058# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3059# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3060# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003061# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003062# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003063# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003064# - this is the reference component of the above
3065# - it still disables RSA and FFDH, but it uses builtin EC algs
3066# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3067# - accelerate all EC and FFDH algs, disable only RSA
3068# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3069# - this is the reference component of the above
3070# - it still disables RSA, but it uses builtin EC and FFDH algs
3071#
3072# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003073# $1: a boolean value which states if we are testing an accelerated scenario
3074# or not.
3075# $2: a string value which states which components are tested. Allowed values
3076# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003077config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003078 driver_only="$1"
3079 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003080 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003081 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003082
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003083 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003084 # Disable modules that are accelerated
3085 scripts/config.py unset MBEDTLS_ECDSA_C
3086 scripts/config.py unset MBEDTLS_ECDH_C
3087 scripts/config.py unset MBEDTLS_ECJPAKE_C
3088 # Disable ECP module (entirely)
3089 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003090 # Also disable bignum
3091 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003092 fi
3093
3094 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3095 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3096 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3097 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3098
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003099 # RSA support is intentionally disabled on this test because RSA_C depends
3100 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003101 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3102 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 +02003103 scripts/config.py unset MBEDTLS_RSA_C
3104 scripts/config.py unset MBEDTLS_PKCS1_V15
3105 scripts/config.py unset MBEDTLS_PKCS1_V21
3106 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3107 # Also disable key exchanges that depend on RSA
3108 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3109 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3110 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3111 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3112 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3113
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003114 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003115 # When testing ECC only, we disable FFDH support, both from builtin and
3116 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003117 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003118 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 +01003119 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003120 scripts/config.py unset MBEDTLS_DHM_C
3121 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3122 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3123 else
3124 # When testing ECC and DH instead, we disable DHM and depending key
3125 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003126 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003127 scripts/config.py unset MBEDTLS_DHM_C
3128 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3129 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3130 fi
3131 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003132
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003133 # Restartable feature is not yet supported by PSA. Once it will in
3134 # the future, the following line could be removed (see issues
3135 # 6061, 6332 and following ones)
3136 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3137}
3138
Valerio Setti4e2f2442023-08-15 10:10:26 +02003139# Common helper used by:
3140# - component_test_psa_crypto_config_accel_ecc_no_bignum
3141# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003142#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003143# The goal is to build and test accelerating either:
3144# - ECC only or
3145# - both ECC and FFDH
3146#
3147# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003148# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3149# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003150common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003151 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003152
Valerio Setti5dfaca42023-09-05 08:48:51 +02003153 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003154 if [ "$test_target" = "ECC_DH" ]; then
3155 accel_text="ECC/FFDH"
3156 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003157 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003158 accel_text="ECC"
3159 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003160 fi
3161
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003162 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003163
3164 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003165 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3166 ALG_ECDH \
3167 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003168 $(helper_get_psa_key_type_list "ECC") \
3169 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003170 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003171 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003172 loc_accel_list="$loc_accel_list \
3173 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003174 $(helper_get_psa_key_type_list "DH") \
3175 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003176 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003177
3178 # Configure
3179 # ---------
3180
3181 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003182 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003183 # Disable all the builtin curves. All the required algs are accelerated.
3184 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003185
3186 # Build
3187 # -----
3188
3189 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003190 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3191 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3192 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003193
3194 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3195
Valerio Setti3fe105b2023-10-30 11:08:12 +01003196 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003197
3198 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003199 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3200 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3201 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003202 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003203 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3204 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3205 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
3206 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003207
3208 # Run the tests
3209 # -------------
3210
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003211 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003212
Gilles Peskine21570cf2023-12-22 11:49:50 +01003213 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003214
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003215 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003216 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003217}
3218
Valerio Setti4e2f2442023-08-15 10:10:26 +02003219# Common helper used by:
3220# - component_test_psa_crypto_config_reference_ecc_no_bignum
3221# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3222#
3223# The goal is to build and test a reference scenario (i.e. with builtin
3224# components) compared to the ones used in
3225# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3226#
3227# It is meant to be used in conjunction with
3228# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3229# coverage analysis in "analyze_outcomes.py" script.
3230common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003231 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003232
Valerio Setti5dfaca42023-09-05 08:48:51 +02003233 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003234 if [ "$test_target" = "ECC_DH" ]; then
3235 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003236 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003237 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003238 fi
3239
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003240 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003241
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003242 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003243
Gilles Peskine21570cf2023-12-22 11:49:50 +01003244 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003245
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003246 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003247 make test
3248
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003249 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003250 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003251}
3252
Valerio Setti4e2f2442023-08-15 10:10:26 +02003253component_test_psa_crypto_config_accel_ecc_no_bignum () {
3254 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3255}
3256
3257component_test_psa_crypto_config_reference_ecc_no_bignum () {
3258 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3259}
3260
3261component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3262 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3263}
3264
3265component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3266 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3267}
3268
Valerio Settiac6d35f2023-08-04 12:49:11 +02003269# Helper for setting common configurations between:
3270# - component_test_tfm_config_p256m_driver_accel_ec()
3271# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003272common_tfm_config () {
3273 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003274 cp configs/config-tfm.h "$CONFIG_H"
3275 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3276 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003277
Yanray Wang73bb2312023-09-25 11:21:15 +08003278 # Other config adjustment to make the tests pass.
3279 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003280 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003281 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3282 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003283
Yanray Wang73bb2312023-09-25 11:21:15 +08003284 # Config adjustment for better test coverage in our environment.
3285 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003286 #
3287 # Enable filesystem I/O for the benefit of PK parse/write tests.
3288 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3289}
3290
Valerio Settiac6d35f2023-08-04 12:49:11 +02003291# Keep this in sync with component_test_tfm_config() as they are both meant
3292# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003293component_test_tfm_config_p256m_driver_accel_ec () {
3294 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3295
3296 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003297
Dave Rodgman897bb772023-11-15 16:34:20 +00003298 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003299 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003300
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003301 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003302 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3303 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3304 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib7e95442023-03-21 11:52:33 +01003305 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003306 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3307 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3308 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
3309 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003310 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003311 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003312
Valerio Setti5e18b902023-12-04 12:07:30 +01003313 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3314 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003315 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003316
Valerio Settib7e95442023-03-21 11:52:33 +01003317 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003318 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003319 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003320}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003321
Valerio Settiac6d35f2023-08-04 12:49:11 +02003322# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3323# they are both meant to be used in analyze_outcomes.py for driver's coverage
3324# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003325component_test_tfm_config() {
3326 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003327
Dave Rodgman897bb772023-11-15 16:34:20 +00003328 # Disable P256M driver, which is on by default, so that analyze_outcomes
3329 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3330 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3331
Valerio Setti52ba0e32023-08-04 12:43:03 +02003332 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003333 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003334
Dave Rodgman897bb772023-11-15 16:34:20 +00003335 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003336 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003337
Valerio Setti5e18b902023-12-04 12:07:30 +01003338 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3339 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003340 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003341
Valerio Setti52ba0e32023-08-04 12:43:03 +02003342 msg "test: TF-M config"
3343 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003344}
3345
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003346# Common helper for component_full_without_ecdhe_ecdsa() and
3347# component_full_without_ecdhe_ecdsa_and_tls13() which:
3348# - starts from the "full" configuration minus the list of symbols passed in
3349# as 1st parameter
3350# - build
3351# - test only TLS (i.e. test_suite_tls and ssl-opt)
3352build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003353 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003354
3355 msg "build: full minus something, test TLS"
3356
3357 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003358 for sym in $symbols_to_disable; do
3359 echo "Disabling $sym"
3360 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003361 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003362
Gilles Peskine21570cf2023-12-22 11:49:50 +01003363 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003364
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003365 msg "test: full minus something, test TLS"
3366 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003367
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003368 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003369 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003370}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003371
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003372component_full_without_ecdhe_ecdsa () {
3373 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003374}
3375
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003376component_full_without_ecdhe_ecdsa_and_tls13 () {
3377 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3378 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003379}
3380
Valerio Setti249b18a2023-06-20 12:08:30 +02003381# This is an helper used by:
3382# - component_test_psa_ecc_key_pair_no_derive
3383# - component_test_psa_ecc_key_pair_no_generate
3384# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3385# enabled, but one. Input arguments are as follows:
3386# - $1 is the key type under test, i.e. ECC/RSA/DH
3387# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003388build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003389 key_type=$1
3390 unset_option=$2
3391 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003392
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003393 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003394 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003395 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3396 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3397
3398 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3399 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003400 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003401
Gilles Peskine21570cf2023-12-22 11:49:50 +01003402 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003403
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003404 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003405 make test
3406}
3407
3408component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003409 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003410}
3411
3412component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003413 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003414}
3415
Pengyu Lve705f572023-12-06 16:38:15 +08003416config_psa_crypto_accel_rsa () {
3417 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003418
Pengyu Lve705f572023-12-06 16:38:15 +08003419 # Start from crypto_full config (no X.509, no TLS)
3420 helper_libtestdriver1_adjust_config "crypto_full"
3421
3422 if [ "$driver_only" -eq 1 ]; then
3423 # Remove RSA support and its dependencies
3424 scripts/config.py unset MBEDTLS_RSA_C
3425 scripts/config.py unset MBEDTLS_PKCS1_V15
3426 scripts/config.py unset MBEDTLS_PKCS1_V21
3427
3428 # We need PEM parsing in the test library as well to support the import
3429 # of PEM encoded RSA keys.
3430 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3431 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3432 fi
3433}
3434
3435component_test_psa_crypto_config_accel_rsa_crypto () {
3436 msg "build: crypto_full with accelerated RSA"
3437
3438 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3439 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3440 KEY_TYPE_RSA_PUBLIC_KEY \
3441 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3442 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3443 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3444 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003445
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003446 # Configure
3447 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003448
Pengyu Lve705f572023-12-06 16:38:15 +08003449 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003450
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003451 # Build
3452 # -----
3453
Pengyu Lve705f572023-12-06 16:38:15 +08003454 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003455 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 +08003456 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003457 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003458
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003459 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003460
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003461 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003462 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003463
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003464 # Run the tests
3465 # -------------
3466
Pengyu Lve705f572023-12-06 16:38:15 +08003467 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003468 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003469}
3470
3471component_test_psa_crypto_config_reference_rsa_crypto () {
3472 msg "build: crypto_full with non-accelerated RSA"
3473
3474 # Configure
3475 # ---------
3476 config_psa_crypto_accel_rsa 0
3477
3478 # Build
3479 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003480 make
Pengyu Lve705f572023-12-06 16:38:15 +08003481
3482 # Run the tests
3483 # -------------
3484 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003485 make test
3486}
3487
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003488# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003489# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003490component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003491 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003492
Valerio Setti4590bc22023-06-13 15:39:23 +02003493 # Create a temporary output file unless there is already one set
3494 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3495 REMOVE_OUTCOME_ON_EXIT="no"
3496 else
3497 REMOVE_OUTCOME_ON_EXIT="yes"
3498 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3499 export MBEDTLS_TEST_OUTCOME_FILE
3500 fi
3501
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003502 # Start from crypto configuration
3503 scripts/config.py crypto
3504
3505 # Remove RSA support and its dependencies
3506 scripts/config.py unset MBEDTLS_PKCS1_V15
3507 scripts/config.py unset MBEDTLS_PKCS1_V21
3508 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3509 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3510 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3511 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3512 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3513 scripts/config.py unset MBEDTLS_RSA_C
3514 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3515
3516 # Enable PSA support
3517 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3518
Valerio Setti01cc88a2023-06-15 11:53:08 +02003519 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003520 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003521 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3522 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3523 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003524
3525 make
3526
Valerio Setti01cc88a2023-06-15 11:53:08 +02003527 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003528 make test
3529
3530 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3531 # performing RSA signature.
3532 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3533 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3534
3535 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3536 rm $MBEDTLS_TEST_OUTCOME_FILE
3537 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003538}
3539
Ronald Cronb2312452021-05-08 14:32:59 +02003540component_test_psa_crypto_config_accel_hash () {
3541 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3542
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003543 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3544 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3545 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003546
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003547 # Configure
3548 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003549
Ronald Cron46ac0652024-03-18 12:39:04 +01003550 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003551 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003552
3553 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003554 scripts/config.py unset MBEDTLS_MD5_C
3555 scripts/config.py unset MBEDTLS_RIPEMD160_C
3556 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003557 scripts/config.py unset MBEDTLS_SHA224_C
3558 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003559 scripts/config.py unset MBEDTLS_SHA384_C
3560 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003561 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003562
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003563 # Build
3564 # -----
3565
3566 helper_libtestdriver1_make_drivers "$loc_accel_list"
3567
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003568 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003569
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003570 # There's a risk of something getting re-enabled via config_psa.h;
3571 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003572 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3573 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3574 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3575 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3576 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003577
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003578 # Run the tests
3579 # -------------
3580
Ronald Cronb2312452021-05-08 14:32:59 +02003581 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3582 make test
3583}
3584
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003585# Auxiliary function to build config for hashes with and without drivers
3586config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003587 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003588 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003589 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003590 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003591 # disable the built-in implementation of hashes
3592 scripts/config.py unset MBEDTLS_MD5_C
3593 scripts/config.py unset MBEDTLS_RIPEMD160_C
3594 scripts/config.py unset MBEDTLS_SHA1_C
3595 scripts/config.py unset MBEDTLS_SHA224_C
3596 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003597 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003598 scripts/config.py unset MBEDTLS_SHA384_C
3599 scripts/config.py unset MBEDTLS_SHA512_C
3600 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003601 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003602 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003603}
3604
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003605# Note that component_test_psa_crypto_config_reference_hash_use_psa
3606# is related to this component and both components need to be kept in sync.
3607# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003608component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003609 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003610
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003611 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3612 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3613 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003614
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003615 # Configure
3616 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003617
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003618 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003619
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003620 # Build
3621 # -----
3622
3623 helper_libtestdriver1_make_drivers "$loc_accel_list"
3624
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003625 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003626
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003627 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003628 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003629 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3630 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3631 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3632 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3633 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003634
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003635 # Run the tests
3636 # -------------
3637
Gilles Peskine14302ed2023-07-19 19:30:04 +02003638 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003639 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003640
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003641 # This is mostly useful so that we can later compare outcome files with
3642 # the reference config in analyze_outcomes.py, to check that the
3643 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003644 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003645 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003646
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003647 # This is to make sure all ciphersuites are exercised, but we don't need
3648 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003649 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003650 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003651}
3652
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003653# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3654# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3655# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3656# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003657component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003658 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003659
3660 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003661
Gilles Peskine21570cf2023-12-22 11:49:50 +01003662 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003663
Gilles Peskine14302ed2023-07-19 19:30:04 +02003664 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003665 make test
3666
Gilles Peskine14302ed2023-07-19 19:30:04 +02003667 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003668 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003669}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003670
Valerio Setti8eb310c2024-01-22 16:22:57 +01003671# Auxiliary function to build config for hashes with and without drivers
3672config_psa_crypto_hmac_use_psa () {
3673 driver_only="$1"
3674 # start with config full for maximum coverage (also enables USE_PSA)
3675 helper_libtestdriver1_adjust_config "full"
3676
Valerio Setticd89b0b2024-01-24 14:24:55 +01003677 if [ "$driver_only" -eq 1 ]; then
3678 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3679 # is still enabled though (for ENTROPY_C among others).
3680 scripts/config.py unset MBEDTLS_MD_C
3681 # Disable also the builtin hashes since they are supported by the driver
3682 # and MD module is able to perform PSA dispathing.
3683 scripts/config.py unset-all MBEDTLS_SHA
3684 scripts/config.py unset MBEDTLS_MD5_C
3685 scripts/config.py unset MBEDTLS_RIPEMD160_C
3686 fi
3687
Valerio Setti8eb310c2024-01-22 16:22:57 +01003688 # Direct dependencies of MD_C. We disable them also in the reference
3689 # component to work with the same set of features.
3690 scripts/config.py unset MBEDTLS_PKCS7_C
3691 scripts/config.py unset MBEDTLS_PKCS5_C
3692 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3693 scripts/config.py unset MBEDTLS_HKDF_C
3694 # Dependencies of HMAC_DRBG
3695 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3696 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3697}
3698
3699component_test_psa_crypto_config_accel_hmac() {
3700 msg "test: full with accelerated hmac"
3701
3702 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3703 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3704 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3705 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3706
3707 # Configure
3708 # ---------
3709
3710 config_psa_crypto_hmac_use_psa 1
3711
Valerio Setti8eb310c2024-01-22 16:22:57 +01003712 # Build
3713 # -----
3714
3715 helper_libtestdriver1_make_drivers "$loc_accel_list"
3716
3717 helper_libtestdriver1_make_main "$loc_accel_list"
3718
3719 # Ensure that built-in support for HMAC is disabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003720 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
Valerio Setti8eb310c2024-01-22 16:22:57 +01003721
3722 # Run the tests
3723 # -------------
3724
3725 msg "test: full with accelerated hmac"
3726 make test
3727}
3728
3729component_test_psa_crypto_config_reference_hmac() {
3730 msg "test: full without accelerated hmac"
3731
3732 config_psa_crypto_hmac_use_psa 0
3733
3734 make
3735
3736 msg "test: full without accelerated hmac"
3737 make test
3738}
3739
Valerio Setti9da01a72023-12-18 17:38:18 +01003740component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003741 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003742
Valerio Setti9da01a72023-12-18 17:38:18 +01003743 # Albeit this components aims at accelerating DES which should only support
3744 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3745 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003746 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3747 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3748 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003749
Valerio Setti9da01a72023-12-18 17:38:18 +01003750 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3751 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3752 # of this component. This limitation will be addressed by #8598.
3753
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003754 # Configure
3755 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003756
Valerio Setti9a427302023-10-17 11:40:42 +02003757 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003758 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003759
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003760 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003761 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3762 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3763 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3764 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3765 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3766 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3767 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003768 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003769
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003770 # Build
3771 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003772
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003773 helper_libtestdriver1_make_drivers "$loc_accel_list"
3774
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003775 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003776
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003777 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003778 not grep mbedtls_des* ${BUILTIN_SRC_PATH}/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003779
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003780 # Run the tests
3781 # -------------
3782
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003783 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003784 make test
3785}
3786
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003787component_test_psa_crypto_config_accel_aead () {
3788 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3789
Valerio Setti3f02bb72023-10-02 15:57:33 +02003790 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3791 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003792
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003793 # Configure
3794 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003795
Valerio Setti3f02bb72023-10-02 15:57:33 +02003796 # Start from full config
3797 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003798
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003799 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003800 scripts/config.py unset MBEDTLS_GCM_C
3801 scripts/config.py unset MBEDTLS_CCM_C
3802 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003803
Valerio Settia50b89e2023-11-08 15:58:47 +01003804 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3805 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003806
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003807 # Build
3808 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003809
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003810 helper_libtestdriver1_make_drivers "$loc_accel_list"
3811
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003812 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003813
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003814 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003815 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3816 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3817 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
Przemek Stekielee1bb412022-10-11 11:52:25 +02003818
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003819 # Run the tests
3820 # -------------
3821
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003822 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3823 make test
3824}
3825
Valerio Settib680fc42023-10-13 09:29:37 +02003826# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003827# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3828# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3829common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003830 # Start from the full config
3831 helper_libtestdriver1_adjust_config "full"
3832
Valerio Settib680fc42023-10-13 09:29:37 +02003833 scripts/config.py unset MBEDTLS_NIST_KW_C
3834}
3835
Valerio Settib6b301f2023-10-04 12:05:05 +02003836# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003837# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3838# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003839# are meant to be used together in analyze_outcomes.py script in order to test
3840# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003841component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3842 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003843
Valerio Settiad8b7f02023-10-25 12:39:50 +02003844 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 +01003845 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003846 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003847 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3848
3849 # Configure
3850 # ---------
3851
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003852 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003853
3854 # Disable the things that are being accelerated
3855 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3856 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3857 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3858 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3859 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3860 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3861 scripts/config.py unset MBEDTLS_GCM_C
3862 scripts/config.py unset MBEDTLS_CCM_C
3863 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003864 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003865 scripts/config.py unset MBEDTLS_DES_C
3866 scripts/config.py unset MBEDTLS_AES_C
3867 scripts/config.py unset MBEDTLS_ARIA_C
3868 scripts/config.py unset MBEDTLS_CHACHA20_C
3869 scripts/config.py unset MBEDTLS_CAMELLIA_C
3870
Valerio Settiec9b2582023-11-08 16:50:54 +01003871 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3872 # does not depend on it.
3873 scripts/config.py unset MBEDTLS_CIPHER_C
3874
Valerio Settib6b301f2023-10-04 12:05:05 +02003875 # Build
3876 # -----
3877
3878 helper_libtestdriver1_make_drivers "$loc_accel_list"
3879
3880 helper_libtestdriver1_make_main "$loc_accel_list"
3881
3882 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003883 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
3884 not grep mbedtls_des ${BUILTIN_SRC_PATH}/des.o
3885 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
3886 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
3887 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
3888 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3889 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3890 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
3891 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003892
3893 # Run the tests
3894 # -------------
3895
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003896 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003897 make test
Valerio Settif9414552023-11-09 10:43:20 +01003898
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003899 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003900 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003901
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003902 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003903 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003904}
3905
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003906component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3907 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3908 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003909
Gilles Peskine21570cf2023-12-22 11:49:50 +01003910 make
Valerio Settif9414552023-11-09 10:43:20 +01003911
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003912 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003913 make test
Valerio Settif9414552023-11-09 10:43:20 +01003914
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003915 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003916 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003917
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003918 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003919 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003920}
3921
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003922common_block_cipher_dispatch() {
3923 TEST_WITH_DRIVER="$1"
3924
3925 # Start from the full config
3926 helper_libtestdriver1_adjust_config "full"
3927
3928 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3929 # Disable key types that are accelerated (there is no legacy equivalent
3930 # symbol for ECB)
3931 scripts/config.py unset MBEDTLS_AES_C
3932 scripts/config.py unset MBEDTLS_ARIA_C
3933 scripts/config.py unset MBEDTLS_CAMELLIA_C
3934 fi
3935
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003936 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003937 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003938 # Keep this also in the reference component in order to skip the same tests
3939 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003940 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
3941 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
3942 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
3943 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
3944 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
3945 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
3946 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02003947 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003948
3949 # Disable direct dependency on AES_C
3950 scripts/config.py unset MBEDTLS_NIST_KW_C
3951
3952 # Prevent the cipher module from using deprecated PSA path. The reason is
3953 # that otherwise there will be tests relying on "aes_info" (defined in
3954 # "cipher_wrap.c") whose functions are not available when AES_C is
3955 # not defined. ARIA and Camellia are not a problem in this case because
3956 # the PSA path is not tested for these key types.
3957 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
3958}
3959
Valerio Settif8e6cba2023-12-12 11:53:39 +01003960component_test_full_block_cipher_psa_dispatch () {
3961 msg "build: full + PSA dispatch in block_cipher"
3962
3963 loc_accel_list="ALG_ECB_NO_PADDING \
3964 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
3965
3966 # Configure
3967 # ---------
3968
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003969 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01003970
Valerio Settif8e6cba2023-12-12 11:53:39 +01003971 # Build
3972 # -----
3973
3974 helper_libtestdriver1_make_drivers "$loc_accel_list"
3975
3976 helper_libtestdriver1_make_main "$loc_accel_list"
3977
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003978 # Make sure disabled components were not re-enabled by accident (additive
3979 # config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003980 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
3981 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
3982 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003983
Valerio Settif8e6cba2023-12-12 11:53:39 +01003984 # Run the tests
3985 # -------------
3986
3987 msg "test: full + PSA dispatch in block_cipher"
3988 make test
3989}
3990
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003991# This is the reference component of component_test_full_block_cipher_psa_dispatch
3992component_test_full_block_cipher_legacy_dispatch () {
3993 msg "build: full + legacy dispatch in block_cipher"
3994
3995 common_block_cipher_dispatch 0
3996
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003997 make
3998
3999 msg "test: full + legacy dispatch in block_cipher"
4000 make test
4001}
4002
Gilles Peskine36dea152023-07-20 22:19:45 +02004003component_test_aead_chachapoly_disabled() {
4004 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004005 scripts/config.py full
4006 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004007 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004008 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004009
Gilles Peskine36dea152023-07-20 22:19:45 +02004010 msg "test: full minus CHACHAPOLY"
4011 make test
4012}
4013
4014component_test_aead_only_ccm() {
4015 msg "build: full minus CHACHAPOLY and GCM"
4016 scripts/config.py full
4017 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4018 scripts/config.py unset MBEDTLS_GCM_C
4019 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4020 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004021 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004022
4023 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004024 make test
4025}
4026
Ronald Crone501d0e2023-07-10 08:31:19 +02004027component_test_ccm_aes_sha256() {
4028 msg "build: CCM + AES + SHA256 configuration"
4029
Ronald Cron7612d8c2023-07-20 10:03:54 +02004030 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004031 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004032
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004033 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004034
4035 msg "test: CCM + AES + SHA256 configuration"
4036 make test
4037}
4038
Dave Rodgman904c5892023-06-28 17:36:02 +01004039support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004040 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004041}
4042
Dave Rodgman904c5892023-06-28 17:36:02 +01004043component_build_tfm_armcc() {
4044 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004045 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004046
Dave Rodgman88651c42023-06-29 12:35:51 +01004047 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004048 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 +01004049}
4050
4051component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004052 # Check that the TF-M configuration can build cleanly with various
4053 # warning flags enabled. We don't build or run tests, since the
4054 # TF-M configuration needs a TF-M platform. A tweaked version of
4055 # the configuration that works on mainstream platforms is in
4056 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004057 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004058
Dave Rodgman88651c42023-06-29 12:35:51 +01004059 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004060 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 +01004061
Dave Rodgman904c5892023-06-28 17:36:02 +01004062 msg "build: TF-M config, gcc native build"
4063 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004064 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 +01004065}
4066
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004067# Test that the given .o file builds with all (valid) combinations of the given options.
4068#
4069# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4070#
4071# The validator function is the name of a function to validate the combination of options.
4072# It may be "" if all combinations are valid.
4073# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004074# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004075build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004076 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004077 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004078 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004079 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004080 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004081
Dave Rodgman42436102023-10-03 15:47:05 +01004082 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004083 for opt in "${options[@]}"; do
4084 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004085 done
4086
Ronald Cron709bbf02024-07-03 07:59:30 +02004087 # enter the library directory
4088 cd library
Dave Rodgman42436102023-10-03 15:47:05 +01004089
Dave Rodgman920343a2023-10-01 18:41:09 +01004090 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004091 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 +01004092
Dave Rodgman42436102023-10-03 15:47:05 +01004093 # Extract the command generated by the Makefile to build the target file.
4094 # This ensures that we have any include paths, macro definitions, etc
4095 # that may be applied by make.
4096 # 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 +01004097 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004098
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004099 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004100 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004101
Dave Rodgman28e38d82023-10-04 11:50:30 +01004102 len=${#options[@]}
Ronald Cron709bbf02024-07-03 07:59:30 +02004103 source_file=../${file%.o}.c
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004104
4105 targets=0
4106 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004107
Dave Rodgman28e38d82023-10-04 11:50:30 +01004108 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004109 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004110 # each bit of $i is used to determine if options[i] will be set or not
4111 target="t"
4112 clang_args=""
4113 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004114 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004115 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004116 clang_args="${clang_args} ${opt}"
4117 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004118 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004119 done
4120
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004121 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004122 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004123 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004124 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004125
Dave Rodgman28e38d82023-10-04 11:50:30 +01004126 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004127 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004128 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004129 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004130
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004131 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004132
Dave Rodgman920343a2023-10-01 18:41:09 +01004133 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004134 make -s -f ${makefile} build_test_config_combos
4135 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004136
4137 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004138 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004139}
4140
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004141validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004142 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004143 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4144 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004145 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004146 fi
4147 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004148 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004149}
4150
4151component_build_aes_variations() {
4152 # 18s - around 90ms per clang invocation on M1 Pro
4153 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004154 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004155 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004156
Yanray Wangbc29aef2023-11-06 11:08:17 +08004157 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004158 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004159
Ronald Cron709bbf02024-07-03 07:59:30 +02004160 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004161 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4162 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004163 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004164 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004165
4166 cd "$MBEDTLS_ROOT_DIR"
4167 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4168
Yanray Wang42be1ba2023-11-23 14:28:47 +08004169 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004170 # manually set or unset those configurations to check
4171 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004172 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4173 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4174 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4175 scripts/config.py unset MBEDTLS_DES_C
4176 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron709bbf02024-07-03 07:59:30 +02004177 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004178 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4179 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004180 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004181 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004182}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004183
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004184component_test_no_platform () {
4185 # Full configuration build, without platform support, file IO and net sockets.
4186 # This should catch missing mbedtls_printf definitions, and by disabling file
4187 # IO, it should catch missing '#include <stdio.h>'
4188 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004189 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004190 scripts/config.py unset MBEDTLS_PLATFORM_C
4191 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004192 scripts/config.py unset MBEDTLS_FS_IO
4193 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004194 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004195 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004196 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004197 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004198 # to re-enable platform integration features otherwise disabled in C99 builds
4199 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004200 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004201}
Gilles Peskine7c652162017-12-11 00:01:40 +01004202
4203component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004204 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004205 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4206 scripts/config.py full
4207 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004208 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4209 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4210 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4211 make
4212}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004213
Gilles Peskine8f073122018-11-27 15:58:47 +01004214component_build_no_ssl_srv () {
4215 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004216 scripts/config.py full
4217 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004218 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004219}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004220
Gilles Peskine8f073122018-11-27 15:58:47 +01004221component_build_no_ssl_cli () {
4222 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004223 scripts/config.py full
4224 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004225 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004226}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004227
Gilles Peskine8f073122018-11-27 15:58:47 +01004228component_build_no_sockets () {
4229 # Note, C99 compliance can also be tested with the sockets support disabled,
4230 # as that requires a POSIX platform (which isn't the same as C99).
4231 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004232 scripts/config.py full
4233 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4234 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4235 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4236}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004237
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004238component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004239 msg "build: default config with memory buffer allocator and backtrace enabled"
4240 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4241 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4242 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004243 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004244 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004245 make
4246
4247 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4248 make test
4249}
4250
4251component_test_memory_buffer_allocator () {
4252 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004253 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4254 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004255 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004256 make
4257
4258 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4259 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004260
4261 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4262 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004263 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004264}
4265
Gilles Peskine8f073122018-11-27 15:58:47 +01004266component_test_no_max_fragment_length () {
4267 # Run max fragment length tests with MFL disabled
4268 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004269 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004270 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004271 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004272
Gilles Peskine8f073122018-11-27 15:58:47 +01004273 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004274 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004275}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004276
Hanno Becker545ced42019-02-19 11:10:48 +00004277component_test_asan_remove_peer_certificate () {
4278 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004279 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004280 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004281 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004282 make
4283
4284 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4285 make test
4286
4287 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004288 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004289
4290 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004291 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004292
4293 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004294 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004295}
4296
Gilles Peskine8f073122018-11-27 15:58:47 +01004297component_test_no_max_fragment_length_small_ssl_out_content_len () {
4298 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004299 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4300 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4301 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004302 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004303 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004304
Gilles Peskine8f073122018-11-27 15:58:47 +01004305 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004306 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004307
4308 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004309 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004310}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004311
Darryl Greenaad82f92019-12-02 10:53:11 +00004312component_test_variable_ssl_in_out_buffer_len () {
4313 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4314 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004315 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004316 make
4317
4318 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4319 make test
4320
4321 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004322 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004323
4324 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004325 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004326}
4327
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004328component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004329 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004330 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004331
Dave Rodgman17127e92023-12-14 16:42:48 +00004332 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004333 make
4334
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004335 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004336 make test
4337
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004338 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004339 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004340
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004341 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004342 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004343}
4344
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004345component_test_ssl_alloc_buffer_and_mfl () {
4346 msg "build: default config with memory buffer allocator and MFL extension"
4347 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4348 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4349 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4350 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4351 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004352 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004353 make
4354
4355 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4356 make test
4357
4358 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 +02004359 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004360}
4361
Gilles Peskine636c26a2020-03-04 20:46:15 +01004362component_test_when_no_ciphersuites_have_mac () {
4363 msg "build: when no ciphersuites have MAC"
Ronald Cron0417a2c2024-05-24 14:22:11 +02004364 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4365 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4366 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4367 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4368 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
4369
Gilles Peskine636c26a2020-03-04 20:46:15 +01004370 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004371 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004372 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron0417a2c2024-05-24 14:22:11 +02004373
Gilles Peskine636c26a2020-03-04 20:46:15 +01004374 make
4375
Ronald Croncd33cd62024-05-27 08:14:27 +02004376 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004377 make test
4378
Ronald Croncd33cd62024-05-27 08:14:27 +02004379 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004380 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004381}
4382
Raoul Strackxa4e86142020-06-15 17:03:13 +02004383component_test_no_date_time () {
4384 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4385 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004386 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004387 make
4388
4389 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4390 make test
4391}
4392
Gilles Peskine8f073122018-11-27 15:58:47 +01004393component_test_platform_calloc_macro () {
4394 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004395 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4396 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4397 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004398 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004399 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004400
Gilles Peskine8f073122018-11-27 15:58:47 +01004401 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4402 make test
4403}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004404
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004405component_test_malloc_0_null () {
4406 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004407 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004408 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 +02004409
4410 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4411 make test
4412
4413 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4414 # Just the calloc selftest. "make test" ran the others as part of the
4415 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004416 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004417
4418 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4419 # Run a subset of the tests. The choice is a balance between coverage
4420 # and time (including time indirectly wasted due to flaky tests).
4421 # The current choice is to skip tests whose description includes
4422 # "proxy", which is an approximation of skipping tests that use the
4423 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004424 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004425}
4426
Dave Rodgman6a08b682023-06-19 11:51:33 +01004427support_test_aesni() {
4428 # Check that gcc targets x86_64 (we can build AESNI), and check for
4429 # AESNI support on the host (we can run AESNI).
4430 #
4431 # The name of this function is possibly slightly misleading, but needs to align
4432 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004433 #
4434 # In principle 32-bit x86 can support AESNI, but our implementation does not
4435 # support 32-bit x86, so we check for x86-64.
4436 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004437 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4438 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004439 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004440}
4441
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004442component_test_aesni () { # ~ 60s
4443 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4444 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4445 #
4446 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4447 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4448 # exercise the plain C impl).
4449
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004450 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004451 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004452 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004453 scripts/config.py set MBEDTLS_HAVE_ASM
4454
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004455 # test the intrinsics implementation
4456 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004457 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004458 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004459 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004460 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004461
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004462 # test the asm implementation
4463 msg "AES tests, test assembly"
4464 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004465 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004466 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004467 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004468
4469 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004470 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004471 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004472 msg "AES tests, plain C"
4473 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004474 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004475 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004476 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004477 not grep -q "AES note: using AESNI" ./programs/test/selftest
4478 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004479
4480 # test the intrinsics implementation
4481 scripts/config.py set MBEDTLS_AESNI_C
4482 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4483 msg "AES tests, test AESNI only"
4484 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004485 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004486 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4487 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004488 grep -q "AES note: using AESNI" ./programs/test/selftest
4489 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004490}
4491
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004492component_test_sha3_variations() {
4493 msg "sha3 loop unroll variations"
4494
4495 # define minimal config sufficient to test SHA3
4496 cat > include/mbedtls/mbedtls_config.h << END
4497 #define MBEDTLS_SELF_TEST
4498 #define MBEDTLS_SHA3_C
4499END
4500
4501 msg "all loops unrolled"
4502 make clean
4503 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"
4504 ./tests/test_suite_shax
4505
4506 msg "all loops rolled up"
4507 make clean
4508 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"
4509 ./tests/test_suite_shax
4510}
4511
Jerry Yub6d39c22023-08-16 15:11:48 +08004512support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004513 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004514}
4515
4516component_test_aesni_m32 () { # ~ 60s
4517 # This tests are duplicated from component_test_aesni for i386 target
4518 #
4519 # AESNI intrinsic code supports i386 and assembly code does not support it.
4520
4521 msg "build: default config with different AES implementations"
4522 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004523 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4524 scripts/config.py set MBEDTLS_HAVE_ASM
4525
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004526 # test the intrinsics implementation with gcc
4527 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004528 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004529 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004530 # check that we built intrinsics - this should be used by default when supported by the compiler
4531 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4532 grep -q "AES note: using AESNI" ./programs/test/selftest
4533 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004534 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4535
4536 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004537 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4538 msg "AES tests, test AESNI only"
4539 make clean
4540 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4541 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4542 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4543 grep -q "AES note: using AESNI" ./programs/test/selftest
4544 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004545 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4546}
4547
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004548support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004549 # clang >= 4 is required to build with target attributes
4550 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004551}
4552
4553component_test_aesni_m32_clang() {
4554
4555 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004556 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4557 scripts/config.py set MBEDTLS_HAVE_ASM
4558
4559 # test the intrinsics implementation with clang
4560 msg "AES tests, test intrinsics (clang)"
4561 make clean
4562 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4563 # check that we built intrinsics - this should be used by default when supported by the compiler
4564 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4565 grep -q "AES note: using AESNI" ./programs/test/selftest
4566 grep -q "AES note: built-in implementation." ./programs/test/selftest
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004567 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4568}
4569
Jerry Yu193cbc02023-08-03 17:06:29 +08004570# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4571component_build_aes_aesce_armcc () {
4572 msg "Build: AESCE test on arm64 platform without plain C."
4573 scripts/config.py baremetal
4574
4575 # armc[56] don't support SHA-512 intrinsics
4576 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4577
4578 # Stop armclang warning about feature detection for A64_CRYPTO.
4579 # With this enabled, the library does build correctly under armclang,
4580 # but in baremetal builds (as tested here), feature detection is
4581 # unavailable, and the user is notified via a #warning. So enabling
4582 # this feature would prevent us from building with -Werror on
4583 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004584 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004585 scripts/config.py set MBEDTLS_HAVE_ASM
4586
4587 msg "AESCE, build with default configuration."
4588 scripts/config.py set MBEDTLS_AESCE_C
4589 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4590 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4591
4592 msg "AESCE, build AESCE only"
4593 scripts/config.py set MBEDTLS_AESCE_C
4594 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4595 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4596}
4597
Dave Rodgman0c584032023-10-08 12:26:54 +01004598support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004599 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004600 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004601}
4602
4603component_build_aes_armce () {
4604 # Test variations of AES with Armv8 crypto extensions
4605 scripts/config.py set MBEDTLS_AESCE_C
4606 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4607
4608 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004609 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 +01004610
4611 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
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-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004613
4614 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004615 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 +01004616
Dave Rodgman5e419372023-10-23 15:30:20 +01004617 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004618
Dave Rodgman5e419372023-10-23 15:30:20 +01004619 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004620 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 +01004621
Dave Rodgman5e419372023-10-23 15:30:20 +01004622 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
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-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004624
Dave Rodgman5e419372023-10-23 15:30:20 +01004625 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004626 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 +01004627
4628 # test for presence of AES instructions
4629 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4630 msg "clang, test A32 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-a72+crypto -marm -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 T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004634 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4635 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004636 msg "clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004637 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4638 grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004639
4640 # test for absence of AES instructions
4641 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4642 scripts/config.py unset MBEDTLS_AESCE_C
4643 msg "clang, test A32 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-a72+crypto -marm -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 T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004647 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4648 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004649 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004650 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4651 not grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004652}
4653
Dave Rodgman9ed18532023-10-05 00:06:47 +01004654support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004655 # clang >= 4 is required to build with SHA extensions
4656 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004657}
4658
Dave Rodgmand9e80832023-10-04 17:17:46 +01004659component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004660 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004661
4662
4663 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004664 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004665 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004666 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 +01004667 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004668 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 +01004669 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004670
Dave Rodgmand9e80832023-10-04 17:17:46 +01004671
Dave Rodgman94a634d2023-10-10 12:59:29 +01004672 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004673 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004674 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004675 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 +01004676 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004677
Dave Rodgman5b89c552023-10-10 14:59:02 +01004678 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004679 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004680 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 +01004681 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004682
Dave Rodgmancd654002023-10-05 09:40:07 +01004683
Dave Rodgman94a634d2023-10-10 12:59:29 +01004684 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004685 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004686 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004687 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 +01004688 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004689 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 +01004690 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004691
Dave Rodgmancd654002023-10-05 09:40:07 +01004692
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004693 # examine the disassembly for presence of SHA instructions
4694 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4695 scripts/config.py set ${opt}
4696 msg "${opt} clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004697 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4698 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004699
4700 msg "${opt} clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004701 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4702 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004703
4704 msg "${opt} clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004705 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4706 grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004707 scripts/config.py unset ${opt}
4708 done
4709
4710
4711 # examine the disassembly for absence of SHA instructions
4712 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004713 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4714 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004715
4716 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004717 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4718 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004719
4720 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004721 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4722 not grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004723}
4724
Jerry Yu193cbc02023-08-03 17:06:29 +08004725support_build_aes_aesce_armcc () {
4726 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004727}
4728
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004729component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004730 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004731 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004732
Dave Rodgmand8d64512023-12-19 12:20:21 +00004733 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004734
4735 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4736 make test
4737}
4738
4739component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4740 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4741 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004742 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004743
Hanno Becker83ebf782017-07-07 12:29:15 +01004744 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004745
4746 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004747 make test
4748}
Gilles Peskine8f073122018-11-27 15:58:47 +01004749
Hanno Becker83ebf782017-07-07 12:29:15 +01004750component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004751 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4752 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004753 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004754 scripts/config.py unset MBEDTLS_AESCE_C
4755
Dave Rodgmand8d64512023-12-19 12:20:21 +00004756 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004757
4758 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004759 make test
4760
4761 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4762 programs/test/selftest
4763}
4764
Matthias Schulz0767fda2024-02-07 10:46:28 +01004765component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004766 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4767 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004768 scripts/config.py unset MBEDTLS_AESNI_C
4769 scripts/config.py unset MBEDTLS_AESCE_C
4770
4771 make CFLAGS='-O2 -Werror -Wall -Wextra'
4772
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004773 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004774 make test
4775}
4776
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004777component_test_aes_fewer_tables () {
4778 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004779 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004780 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004781
Gilles Peskine7c652162017-12-11 00:01:40 +01004782 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004783 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004784}
4785
4786component_test_aes_rom_tables () {
4787 msg "build: default config with AES_ROM_TABLES enabled"
4788 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004789 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004790
4791 msg "test: AES_ROM_TABLES"
4792 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004793}
4794
Gilles Peskine14c3c062018-01-29 21:25:12 +01004795component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004796 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4797 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4798 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004799 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004800
Gilles Peskine8f073122018-11-27 15:58:47 +01004801 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4802 make test
4803}
4804
Yanray Wang49cd4b52023-11-10 11:58:37 +08004805# helper for common_block_cipher_no_decrypt() which:
4806# - enable/disable the list of config options passed from -s/-u respectively.
4807# - build
4808# - test for tests_suite_xxx
4809# - selftest
4810#
4811# Usage: helper_block_cipher_no_decrypt_build_test
4812# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4813# Options: -s set_opts the list of config options to enable
4814# -u unset_opts the list of config options to disable
4815# -c cflags the list of options passed to CFLAGS
4816# -l ldflags the list of options passed to LDFLAGS
4817helper_block_cipher_no_decrypt_build_test () {
4818 while [ $# -gt 0 ]; do
4819 case "$1" in
4820 -s)
4821 shift; local set_opts="$1";;
4822 -u)
4823 shift; local unset_opts="$1";;
4824 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004825 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004826 -l)
4827 shift; local ldflags="$1";;
4828 esac
4829 shift
4830 done
4831 set_opts="${set_opts:-}"
4832 unset_opts="${unset_opts:-}"
4833 cflags="${cflags:-}"
4834 ldflags="${ldflags:-}"
4835
Yanray Wangb2d6e522023-11-13 16:57:47 +08004836 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4837 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004838
4839 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4840 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004841 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004842
4843 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004844 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4845 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4846 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004847 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004848 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004849 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
Ronald Cron709bbf02024-07-03 07:59:30 +02004850 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004851
4852 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4853 make test
4854
4855 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4856 programs/test/selftest
4857}
4858
4859# This is a common configuration function used in:
4860# - component_test_block_cipher_no_decrypt_aesni_legacy()
4861# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4862# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4863# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4864# on x86.
4865common_block_cipher_no_decrypt () {
4866 # test AESNI intrinsics
4867 helper_block_cipher_no_decrypt_build_test \
4868 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004869 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004870
4871 # test AESNI assembly
4872 helper_block_cipher_no_decrypt_build_test \
4873 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004874 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004875
4876 # test AES C implementation
4877 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004878 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004879
4880 # test AESNI intrinsics for i386 target
4881 helper_block_cipher_no_decrypt_build_test \
4882 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004883 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004884 -l "-m32"
4885}
4886
Yanray Wang3ae11992023-11-13 17:32:09 +08004887# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4888# usage: 0: no PSA crypto configuration
4889# 1: use PSA crypto configuration
4890config_block_cipher_no_decrypt () {
4891 use_psa=$1
4892
Yanray Wang66111392023-10-31 18:54:54 +08004893 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004894 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4895 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004896 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004897 scripts/config.py unset MBEDTLS_NIST_KW_C
4898
Yanray Wang3ae11992023-11-13 17:32:09 +08004899 if [ "$use_psa" -eq 1 ]; then
4900 # Enable support for cryptographic mechanisms through the PSA API.
4901 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4902 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4903 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4904 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4905 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4906 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4907 fi
4908}
4909
4910component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004911 # This consistently causes an llvm crash on clang 3.8, so use gcc
4912 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004913 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004914 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004915}
4916
Yanray Wangf1496402023-11-01 18:55:13 +08004917component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004918 # This consistently causes an llvm crash on clang 3.8, so use gcc
4919 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004920 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004921 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004922}
4923
Yanray Wang66111392023-10-31 18:54:54 +08004924support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004925 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08004926}
4927
Yanray Wang66111392023-10-31 18:54:54 +08004928component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08004929 scripts/config.py baremetal
4930
4931 # armc[56] don't support SHA-512 intrinsics
4932 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4933
4934 # Stop armclang warning about feature detection for A64_CRYPTO.
4935 # With this enabled, the library does build correctly under armclang,
4936 # but in baremetal builds (as tested here), feature detection is
4937 # unavailable, and the user is notified via a #warning. So enabling
4938 # this feature would prevent us from building with -Werror on
4939 # armclang. Tracked in #7198.
4940 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4941 scripts/config.py set MBEDTLS_HAVE_ASM
4942
Yanray Wang3ae11992023-11-13 17:32:09 +08004943 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08004944
4945 # test AESCE baremetal build
4946 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08004947 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08004948 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08004949
Yanray Wangef1b04d2023-09-08 11:09:26 +08004950 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004951 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4952 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4953 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wangef1b04d2023-09-08 11:09:26 +08004954 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004955 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004956 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Ronald Cron709bbf02024-07-03 07:59:30 +02004957 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
4958 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08004959}
4960
Gilles Peskine592f5912019-10-07 18:49:32 +02004961component_test_ctr_drbg_aes_256_sha_256 () {
4962 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4963 scripts/config.py full
4964 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4965 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004966 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004967 make
4968
4969 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4970 make test
4971}
4972
4973component_test_ctr_drbg_aes_128_sha_512 () {
4974 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004975 scripts/config.py full
4976 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4977 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00004978 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004979 make
4980
4981 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
4982 make test
4983}
4984
4985component_test_ctr_drbg_aes_128_sha_256 () {
4986 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004987 scripts/config.py full
4988 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4989 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
4990 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004991 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004992 make
4993
4994 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4995 make test
4996}
4997
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004998component_test_se_default () {
4999 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005000 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005001 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005002
5003 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5004 make test
5005}
5006
Steven Cooremand57203d2020-07-16 20:28:59 +02005007component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005008 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005009 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005010 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005011 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5012 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005013 loc_cflags="${loc_cflags} -I../tests/include -O2"
5014
Gilles Peskine21570cf2023-12-22 11:49:50 +01005015 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005016
Gilles Peskine1997f302023-07-26 18:45:20 +02005017 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005018 make test
5019}
5020
Gilles Peskine8f073122018-11-27 15:58:47 +01005021component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005022 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005023 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005024 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005025 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005026}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005027
Gilles Peskinecf740502019-07-03 20:43:05 +02005028component_test_cmake_shared () {
5029 msg "build/test: cmake shared" # ~ 2min
5030 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5031 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005032 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005033 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005034 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005035}
5036
Gilles Peskineec10bf12019-09-20 19:56:06 +02005037test_build_opt () {
5038 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005039 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005040 for opt in "$@"; do
5041 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005042 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005043 # We're confident enough in compilers to not run _all_ the tests,
5044 # but at least run the unit tests. In particular, runs with
5045 # optimizations use inline assembly whereas runs with -O0
5046 # skip inline assembly.
5047 make test # ~30s
5048 make clean
5049 done
5050}
5051
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005052# For FreeBSD we invoke the function by name so this condition is added
5053# to disable the existing test_clang_opt function for linux.
5054if [[ $(uname) != "Linux" ]]; then
5055 component_test_clang_opt () {
5056 scripts/config.py full
5057 test_build_opt 'full config' clang -O0 -Os -O2
5058 }
5059fi
5060
5061component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005062 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005063 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005064}
5065support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005066 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005067}
5068
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005069component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005070 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005071 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005072}
5073support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005074 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005075}
5076
5077component_test_gcc_latest_opt () {
5078 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005079 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005080}
5081support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005082 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005083}
5084
5085component_test_gcc_earliest_opt () {
5086 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005087 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005088}
5089support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005090 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005091}
5092
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005093component_build_mbedtls_config_file () {
5094 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005095 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005096 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005097 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005098 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005099 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5100 make clean
5101
5102 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5103 # In the user config, disable one feature (for simplicity, pick a feature
5104 # that nothing else depends on).
5105 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005106 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005107 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5108
5109 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005110}
5111
Gilles Peskine7d904e72022-04-07 21:59:14 +02005112component_build_psa_config_file () {
5113 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5114 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5115 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5116 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5117 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005118 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005119 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5120 make clean
5121
5122 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005123 # In the user config, disable one feature and its dependencies, which will
5124 # reflect on the mbedtls configuration so we can query it with
5125 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005126 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005127 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005128 scripts/config.py unset MBEDTLS_CMAC_C
5129 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5130 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5131
5132 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005133}
5134
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005135component_build_psa_alt_headers () {
5136 msg "build: make with PSA alt headers" # ~20s
5137
5138 # Generate alternative versions of the substitutable headers with the
5139 # same content except different include guards.
5140 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5141
5142 # Build the library and some programs.
5143 # Don't build the fuzzers to avoid having to go through hoops to set
5144 # a correct include path for programs/fuzz/Makefile.
5145 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
5146 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\"'"
5147
5148 # Check that we're getting the alternative include guards and not the
5149 # original include guards.
5150 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5151 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5152 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5153 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5154}
5155
Dave Rodgman852de3c2023-12-14 14:46:45 +00005156component_test_m32_no_asm () {
5157 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005158 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005159 #
5160 # Note that we require gcc, because clang Asan builds fail to link for
5161 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005162 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005163 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005164 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005165 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005166 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005167
Dave Rodgman852de3c2023-12-14 14:46:45 +00005168 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005169 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005170}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005171support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005172 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005173 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005174 *) false;;
5175 esac
5176}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005177
Gilles Peskineff0aee02021-10-05 09:36:03 +02005178component_test_m32_o2 () {
5179 # Build with optimization, to use the i386 specific inline assembly
5180 # and go faster for tests.
5181 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005182 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005183 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005184 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005185
Gilles Peskineff0aee02021-10-05 09:36:03 +02005186 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005187 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005188
Gilles Peskineff0aee02021-10-05 09:36:03 +02005189 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005190 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005191}
Gilles Peskinecf522222021-10-07 19:25:29 +02005192support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005193 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005194}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005195
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005196component_test_m32_everest () {
5197 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005198 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005199 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005200 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005201
5202 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5203 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005204
5205 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005206 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005207
5208 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5209 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005210 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005211}
5212support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005213 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005214}
5215
Gilles Peskine8f073122018-11-27 15:58:47 +01005216component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005217 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005218 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005219 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005220
5221 msg "test: 64-bit ILP32, make, gcc"
5222 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005223}
Gilles Peskine878cf602019-01-06 20:50:38 +00005224support_test_mx32 () {
5225 case $(uname -m) in
5226 amd64|x86_64) true;;
5227 *) false;;
5228 esac
5229}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005230
Peter Kolbus60c6da22018-12-27 06:59:04 -06005231component_test_min_mpi_window_size () {
5232 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005233 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005234 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005235 make
5236
5237 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5238 make test
5239}
5240
Gilles Peskine8f073122018-11-27 15:58:47 +01005241component_test_have_int32 () {
5242 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005243 scripts/config.py unset MBEDTLS_HAVE_ASM
5244 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005245 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005246 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005247
Gilles Peskine8f073122018-11-27 15:58:47 +01005248 msg "test: gcc, force 32-bit bignum limbs"
5249 make test
5250}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005251
Gilles Peskine8f073122018-11-27 15:58:47 +01005252component_test_have_int64 () {
5253 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005254 scripts/config.py unset MBEDTLS_HAVE_ASM
5255 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005256 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005257 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005258
Gilles Peskine8f073122018-11-27 15:58:47 +01005259 msg "test: gcc, force 64-bit bignum limbs"
5260 make test
5261}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005262
Gabor Mezeie256cc12023-07-26 17:28:48 +02005263component_test_have_int32_cmake_new_bignum () {
5264 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5265 scripts/config.py unset MBEDTLS_HAVE_ASM
5266 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005267 scripts/config.py unset MBEDTLS_AESCE_C
5268 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005269 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005270 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005271
5272 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5273 make test
5274}
5275
Gilles Peskine8f073122018-11-27 15:58:47 +01005276component_test_no_udbl_division () {
5277 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005278 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005279 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005280 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005281
Gilles Peskine8f073122018-11-27 15:58:47 +01005282 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5283 make test
5284}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005285
Gilles Peskine8f073122018-11-27 15:58:47 +01005286component_test_no_64bit_multiplication () {
5287 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005288 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005289 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005290 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005291
Gilles Peskine8f073122018-11-27 15:58:47 +01005292 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5293 make test
5294}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005295
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005296component_test_no_strings () {
5297 msg "build: no strings" # ~10s
5298 scripts/config.py full
5299 # Disable options that activate a large amount of string constants.
5300 scripts/config.py unset MBEDTLS_DEBUG_C
5301 scripts/config.py unset MBEDTLS_ERROR_C
5302 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5303 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005304 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005305
5306 msg "test: no strings" # ~ 10s
5307 make test
5308}
5309
Hanno Beckerc5722d12020-10-09 11:10:42 +01005310component_test_no_x509_info () {
5311 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5312 scripts/config.pl full
5313 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5314 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005315 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005316
5317 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5318 make test
5319
5320 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005321 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005322}
5323
Gilles Peskine8f073122018-11-27 15:58:47 +01005324component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005325 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005326 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005327 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 +02005328
Gilles Peskinee36fe812021-09-01 20:00:33 +02005329 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005330 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005331 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005332 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005333}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005334
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005335component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005336 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005337 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005338 # Build for a target platform that's close to what Debian uses
5339 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005340 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005341 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005342 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005343 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'
5344
Gilles Peskinee36fe812021-09-01 20:00:33 +02005345 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005346 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005347 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005348 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005349}
5350support_build_arm_linux_gnueabi_gcc_arm5vte () {
5351 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5352}
5353
5354component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005355 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005356 scripts/config.py baremetal
5357 # This is an imperfect substitute for
5358 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005359 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005360 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 +02005361
Gilles Peskinee36fe812021-09-01 20:00:33 +02005362 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005363 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005364 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005365 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005366}
5367
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005368component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005369 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5370 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005371 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 +02005372
Gilles Peskinee36fe812021-09-01 20:00:33 +02005373 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005374 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005375 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005376 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005377 for lib in library/*.a; do
5378 echo "$lib:"
5379 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5380 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005381}
5382
Gilles Peskine8f073122018-11-27 15:58:47 +01005383component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005384 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005385 scripts/config.py baremetal
5386 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005387 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-std=c99 -Werror -Wall -Wextra' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01005388 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005389 not grep __aeabi_uldiv library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005390 not grep __aeabi_uldiv ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005391 not grep __aeabi_uldiv ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005392}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005393
Gilles Peskine8f073122018-11-27 15:58:47 +01005394component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005395 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005396 scripts/config.py baremetal
5397 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005398 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 +01005399 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005400 not grep __aeabi_lmul library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005401 not grep __aeabi_lmul ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005402 not grep __aeabi_lmul ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005403}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005404
Dave Rodgman8c315f22023-06-02 10:26:24 -04005405component_build_arm_clang_thumb () {
5406 # ~ 30s
5407
5408 scripts/config.py baremetal
5409
5410 msg "build: clang thumb 2, make"
5411 make clean
5412 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5413
5414 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5415 msg "build: clang thumb 1 -O0, make"
5416 make clean
5417 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5418
5419 msg "build: clang thumb 1 -Os, make"
5420 make clean
5421 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5422}
5423
Gilles Peskine8f073122018-11-27 15:58:47 +01005424component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005425 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005426 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005427 # armc[56] don't support SHA-512 intrinsics
5428 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005429
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005430 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5431 scripts/config.py unset MBEDTLS_AESCE_C
5432
Dave Rodgman0fddf822023-03-02 15:32:12 +00005433 # Stop armclang warning about feature detection for A64_CRYPTO.
5434 # With this enabled, the library does build correctly under armclang,
5435 # but in baremetal builds (as tested here), feature detection is
5436 # unavailable, and the user is notified via a #warning. So enabling
5437 # this feature would prevent us from building with -Werror on
5438 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005439 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005440
Hanno Beckerf0762e92022-07-15 12:08:19 +01005441 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005442
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005443 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005444
5445 msg "size: ARM Compiler 5"
5446 "$ARMC5_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005447 "$ARMC5_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005448 "$ARMC5_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine18487f62020-04-30 23:11:54 +02005449
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005450 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005451
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005452 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005453 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005454
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005455 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005456 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5457
5458 # ARM Compiler 6 - Target ARMv7-M+DSP
5459 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005460
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005461 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005462 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005463
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005464 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005465 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005466
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005467 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5468 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5469
Dave Rodgman99318e62023-05-24 12:27:42 +01005470 # ARM Compiler 6 - Target Cortex-M0
5471 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005472
5473 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5474 #
5475 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5476 # that we have in our CI
5477 scripts/config.py set MBEDTLS_AESCE_C
5478 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005479}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005480
Pengyu Lvdf070032023-02-24 16:03:31 +08005481support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005482 armc5_cc="$ARMC5_BIN_DIR/armcc"
5483 armc6_cc="$ARMC6_BIN_DIR/armclang"
5484 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005485}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005486
Ronald Crond2cb7f42024-03-18 12:49:18 +01005487component_test_tls12_only () {
5488 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5489 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5490 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5491 make
5492
5493 msg "test: main suites (inc. selftests) (ASan build)"
5494 make test
5495
5496 msg "test: ssl-opt.sh (ASan build)"
5497 tests/ssl-opt.sh
5498
5499 msg "test: compat.sh (ASan build)"
5500 tests/compat.sh
5501}
5502
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005503component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005504 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005505 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005506 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005507 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5508
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005509 msg "test: TLS 1.3 only, all key exchange modes enabled"
5510 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005511
Ronald Cronc3f43b62022-10-17 17:35:32 +02005512 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5513 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005514}
5515
Ronald Cronc3f43b62022-10-17 17:35:32 +02005516component_test_tls13_only_psk () {
5517 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5518 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5519 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5520 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005521 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005522 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5523 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5524 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5525 scripts/config.py unset MBEDTLS_ECDSA_C
5526 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005527 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005528 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005529 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5530
Ronald Cronc3f43b62022-10-17 17:35:32 +02005531 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5532 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005533
Ronald Cronc3f43b62022-10-17 17:35:32 +02005534 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5535 tests/ssl-opt.sh
5536}
5537
5538component_test_tls13_only_ephemeral () {
5539 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5540 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5541 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005542 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005543 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5544
5545 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5546 cd tests; ./test_suite_ssl; cd ..
5547
5548 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5549 tests/ssl-opt.sh
5550}
5551
Przemek Stekiela01c2422023-06-13 10:46:48 +02005552component_test_tls13_only_ephemeral_ffdh () {
5553 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5554 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5555 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5556 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005557 scripts/config.py unset MBEDTLS_ECDH_C
5558
Przemek Stekiela01c2422023-06-13 10:46:48 +02005559 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5560
5561 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5562 cd tests; ./test_suite_ssl; cd ..
5563
5564 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5565 tests/ssl-opt.sh
5566}
5567
Ronald Cronc3f43b62022-10-17 17:35:32 +02005568component_test_tls13_only_psk_ephemeral () {
5569 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5570 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5571 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5572 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5573 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5574 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5575 scripts/config.py unset MBEDTLS_ECDSA_C
5576 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005577 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005578 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005579 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5580
5581 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5582 cd tests; ./test_suite_ssl; cd ..
5583
5584 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5585 tests/ssl-opt.sh
5586}
5587
Przemek Stekiela01c2422023-06-13 10:46:48 +02005588component_test_tls13_only_psk_ephemeral_ffdh () {
5589 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5590 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5591 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5592 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5593 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5594 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5595 scripts/config.py unset MBEDTLS_ECDSA_C
5596 scripts/config.py unset MBEDTLS_PKCS1_V21
5597 scripts/config.py unset MBEDTLS_PKCS7_C
5598 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005599 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005600 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5601
5602 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5603 cd tests; ./test_suite_ssl; cd ..
5604
5605 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5606 tests/ssl-opt.sh
5607}
5608
Ronald Cronc3f43b62022-10-17 17:35:32 +02005609component_test_tls13_only_psk_all () {
5610 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5611 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5612 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5613 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5614 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5615 scripts/config.py unset MBEDTLS_ECDSA_C
5616 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005617 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005618 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005619 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5620
5621 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5622 cd tests; ./test_suite_ssl; cd ..
5623
5624 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5625 tests/ssl-opt.sh
5626}
5627
5628component_test_tls13_only_ephemeral_all () {
5629 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5630 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005631 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005632 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5633
5634 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5635 cd tests; ./test_suite_ssl; cd ..
5636
5637 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5638 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005639}
5640
Ronald Cron46ac0652024-03-18 12:39:04 +01005641component_test_tls13_no_padding () {
5642 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005643 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005644 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005645 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005646 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005647 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005648 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005649 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005650 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005651}
5652
Ronald Cron6f135e12021-12-08 16:57:54 +01005653component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005654 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005655 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005656 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005657 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005658 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005659 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005660 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005661 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005662 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005663}
5664
Ronald Crondd96c0a2024-04-02 12:34:24 +02005665component_test_full_minus_session_tickets() {
5666 msg "build: full config without session tickets"
5667 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005668 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005669 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005670 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5671 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005672 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005673 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005674 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005675 tests/ssl-opt.sh
5676}
5677
Gilles Peskine8f073122018-11-27 15:58:47 +01005678component_build_mingw () {
5679 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
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 -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 lib programs
Hanno Beckere963efa2018-01-03 10:03:43 +00005681
Gilles Peskine8f073122018-11-27 15:58:47 +01005682 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005683 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 +01005684 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005685
Gilles Peskine8f073122018-11-27 15:58:47 +01005686 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005687 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
5688 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 +01005689 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005690
Pengyu Lv158eead2023-10-19 11:27:05 +08005691 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005692 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005693 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 +01005694 make WINDOWS_BUILD=1 clean
5695}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005696support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005697 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5698 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005699 *) true;;
5700 esac
5701}
Simon Butcher91aef332016-11-17 09:20:50 +00005702
Gilles Peskine8f073122018-11-27 15:58:47 +01005703component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005704 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005705 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005706 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5707 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005708
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005709 msg "test: main suites (MSan)" # ~ 10s
5710 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005711
Gilles Peskine6848d172023-11-02 19:58:03 +01005712 msg "test: metatests (MSan)"
5713 tests/scripts/run-metatests.sh any msan
5714
Gilles Peskine82b27272019-06-14 18:27:03 +02005715 msg "program demos (MSan)" # ~20s
5716 tests/scripts/run_demos.py
5717
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005718 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005719 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005720
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005721 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005722
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005723 if [ "$MEMORY" -gt 0 ]; then
5724 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005725 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005726 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005727}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005728
Bence Szépkúti0354d042023-12-06 16:14:37 +01005729component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005730 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005731 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005732 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5733 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005734
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005735 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005736 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005737
Gilles Peskine636c26a2020-03-04 20:46:15 +01005738 # Optional parts (slow; currently broken on OS X because programs don't
5739 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005740 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005741 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005742 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005743 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005744 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005745
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005746 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005747 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005748 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005749 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005750
5751 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005752 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005753 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005754 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005755}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005756
Bence Szépkúti0354d042023-12-06 16:14:37 +01005757component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005758 msg "build: Release, full (clang)"
5759 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5760 scripts/config.py full
5761 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5762 make
5763
5764 msg "test: main suites, Valgrind (full config)"
5765 make memcheck
5766}
5767
Paul Elliott62dc3922021-11-25 17:29:40 +00005768support_test_cmake_out_of_source () {
5769 distrib_id=""
5770 distrib_ver=""
5771 distrib_ver_minor=""
5772 distrib_ver_major=""
5773
5774 # Attempt to parse lsb-release to find out distribution and version. If not
5775 # found this should fail safe (test is supported).
5776 if [[ -f /etc/lsb-release ]]; then
5777
5778 while read -r lsb_line; do
5779 case "$lsb_line" in
5780 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5781 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5782 esac
5783 done < /etc/lsb-release
5784
5785 distrib_ver_major="${distrib_ver%%.*}"
5786 distrib_ver="${distrib_ver#*.}"
5787 distrib_ver_minor="${distrib_ver%%.*}"
5788 fi
5789
5790 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5791 # processor (as the CI does) can create a race condition whereby the build
5792 # fails to see a generated file, despite that file actually having been
5793 # generated. This problem appears to go away with 18.04 or newer, so make
5794 # the out of source tests unsupported on Ubuntu 16.04.
5795 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5796}
5797
Gilles Peskine8f073122018-11-27 15:58:47 +01005798component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005799 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005800 # generates
5801 make neat
5802
Gilles Peskine8f073122018-11-27 15:58:47 +01005803 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005804 MBEDTLS_ROOT_DIR="$PWD"
5805 mkdir "$OUT_OF_SOURCE_DIR"
5806 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005807 # Note: Explicitly generate files as these are turned off in releases
5808 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005809 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005810
Gilles Peskine8f073122018-11-27 15:58:47 +01005811 msg "test: cmake 'out-of-source' build"
5812 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005813 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005814 # Also ensure that there are no error messages such as
5815 # "No such file or directory", which would indicate that some required
5816 # file is missing (ssl-opt.sh tolerates the absence of some files so
5817 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005818 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005819 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005820 cat ssl-opt.err >&2
5821 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005822 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005823 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005824 cd "$MBEDTLS_ROOT_DIR"
5825 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005826}
Andres AGdc192212016-08-31 17:33:13 +01005827
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005828component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005829 # Remove existing generated files so that we use the ones CMake
5830 # generates
5831 make neat
5832
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005833 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005834 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005835 # Note: Explicitly generate files as these are turned off in releases
5836 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005837 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005838 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005839}
Gilles Peskinea3000992022-02-04 00:21:12 +01005840support_test_cmake_as_subdirectory () {
5841 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005842}
5843
Chris Kayd259e342021-03-25 16:03:25 +00005844component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005845 # Remove existing generated files so that we use the ones CMake
5846 # generates
5847 make neat
5848
Chris Kayd259e342021-03-25 16:03:25 +00005849 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005850 cd programs/test/cmake_package
5851 cmake .
5852 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005853 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005854}
Gilles Peskinea3000992022-02-04 00:21:12 +01005855support_test_cmake_as_package () {
5856 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005857}
5858
5859component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005860 # Remove existing generated files so that we use the ones CMake
5861 # generates
5862 make neat
5863
Chris Kayd259e342021-03-25 16:03:25 +00005864 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005865 cd programs/test/cmake_package_install
5866 cmake .
5867 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005868 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005869}
Gilles Peskinea3000992022-02-04 00:21:12 +01005870support_test_cmake_as_package_install () {
5871 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005872}
5873
David Horstmann20550e32023-01-12 14:17:01 +00005874component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005875 # Make a copy of config file to use for the in-tree test
5876 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005877
5878 MBEDTLS_ROOT_DIR="$PWD"
5879 mkdir "$OUT_OF_SOURCE_DIR"
5880 cd "$OUT_OF_SOURCE_DIR"
5881
David Horstmann969c1452023-01-31 10:34:44 +00005882 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005883 cmake "$MBEDTLS_ROOT_DIR"
5884 make
5885
5886 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5887 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005888 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005889 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5890 make
5891
5892 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5893 # In the user config, disable one feature (for simplicity, pick a feature
5894 # that nothing else depends on).
5895 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5896
5897 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5898 make
5899 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5900
5901 rm -f user_config.h full_config.h
5902
5903 cd "$MBEDTLS_ROOT_DIR"
5904 rm -rf "$OUT_OF_SOURCE_DIR"
5905
5906 # Now repeat the test for an in-tree build:
5907
David Horstmann969c1452023-01-31 10:34:44 +00005908 # Restore config for the in-tree test
5909 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005910
David Horstmann969c1452023-01-31 10:34:44 +00005911 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005912 cmake .
5913 make
5914
5915 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5916 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005917 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005918 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5919 make
5920
5921 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5922 # In the user config, disable one feature (for simplicity, pick a feature
5923 # that nothing else depends on).
5924 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5925
5926 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5927 make
5928 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5929
5930 rm -f user_config.h full_config.h
5931}
5932support_build_cmake_custom_config_file () {
5933 support_test_cmake_out_of_source
5934}
5935
David Horstmann041ed422024-05-10 14:37:48 +01005936component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01005937 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01005938 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
5939 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
5940 make
5941}
5942support_build_cmake_programs_no_testing () {
5943 support_test_cmake_out_of_source
5944}
David Horstmann20550e32023-01-12 14:17:01 +00005945
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005946component_build_zeroize_checks () {
5947 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5948
5949 scripts/config.py full
5950
5951 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00005952 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 +01005953}
5954
5955
Gilles Peskine8f073122018-11-27 15:58:47 +01005956component_test_zeroize () {
5957 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5958 # different combinations of compilers and optimization flags by using an
5959 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5960 # system in all cases that the script fails, so we must manually search the
5961 # output to check whether the pass string is present and no failure strings
5962 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005963
Gilles Peskine4976e822019-01-06 19:52:22 +00005964 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5965 # about a spurious message if Gdb tries and fails, so suppress that.
5966 gdb_disable_aslr=
5967 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
5968 gdb_disable_aslr='set disable-randomization off'
5969 fi
5970
Gilles Peskine8f073122018-11-27 15:58:47 +01005971 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01005972 for compiler in clang gcc; do
5973 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
5974 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005975 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
5976 grep "The buffer was correctly zeroized" test_zeroize.log
5977 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01005978 rm -f test_zeroize.log
5979 make clean
5980 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01005981 done
Gilles Peskine8f073122018-11-27 15:58:47 +01005982}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005983
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005984component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00005985 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005986 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00005987 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005988
5989 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00005990 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005991}
5992
5993support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01005994 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02005995 ver="$(cmake --version)"
5996 ver="${ver#cmake version }"
5997 ver_major="${ver%%.*}"
5998
5999 ver="${ver#*.}"
6000 ver_minor="${ver%%.*}"
6001
6002 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006003}
6004
Gilles Peskinec848d222022-12-09 12:23:35 +01006005component_check_code_style () {
6006 msg "Check C code style"
6007 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006008}
6009
Gilles Peskinec848d222022-12-09 12:23:35 +01006010support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006011 case $(uncrustify --version) in
6012 *0.75.1*) true;;
6013 *) false;;
6014 esac
6015}
6016
Gilles Peskine8f073122018-11-27 15:58:47 +01006017component_check_python_files () {
6018 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006019 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006020}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006021
Joe Subbianid614c0b2021-07-29 11:18:29 +01006022component_check_test_helpers () {
6023 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006024 # unittest writes out mundane stuff like number or tests run on stderr.
6025 # Our convention is to reserve stderr for actual errors, and write
6026 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006027 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006028
Joe Subbiania25ffab2021-08-06 09:41:27 +01006029 msg "unit test: translate_ciphers.py"
6030 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006031}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006032
Valerio Settid9e42512024-05-06 15:59:51 +02006033component_test_psasim() {
Valerio Setti9022f712024-06-27 07:59:39 +02006034 msg "build server library and application"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006035 scripts/config.py crypto
Valerio Settid8b59372024-07-02 12:02:25 +02006036 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006037 helper_psasim_build server
Valerio Settid1b6ef12024-05-07 16:00:21 +02006038
Valerio Settid8b59372024-07-02 12:02:25 +02006039 helper_psasim_cleanup_before_client
Valerio Settif98635c2024-06-10 20:13:13 +02006040
6041 msg "build library for client"
Valerio Settid8b59372024-07-02 12:02:25 +02006042 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006043 helper_psasim_build client
Valerio Settif98635c2024-06-10 20:13:13 +02006044
Valerio Setti5beb2362024-06-24 13:13:17 +02006045 msg "build basic psasim client"
6046 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_base
6047 msg "test basic psasim client"
6048 tests/psa-client-server/psasim/test/run_test.sh psa_client_base
Valerio Settid9e42512024-05-06 15:59:51 +02006049
Valerio Setti5beb2362024-06-24 13:13:17 +02006050 msg "build full psasim client"
6051 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_full
6052 msg "test full psasim client"
6053 tests/psa-client-server/psasim/test/run_test.sh psa_client_full
Valerio Settid9e42512024-05-06 15:59:51 +02006054
Valerio Settid9e42512024-05-06 15:59:51 +02006055 make -C tests/psa-client-server/psasim clean
6056}
Jerry Yud767cc42023-03-31 15:03:55 +08006057
Valerio Setti9022f712024-06-27 07:59:39 +02006058component_test_suite_with_psasim()
6059{
6060 msg "build server library and application"
Valerio Settid8b59372024-07-02 12:02:25 +02006061 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006062 # Modify server's library configuration here (if needed)
6063 helper_psasim_build server
6064
Valerio Settid8b59372024-07-02 12:02:25 +02006065 helper_psasim_cleanup_before_client
Valerio Setti9022f712024-06-27 07:59:39 +02006066
6067 msg "build client library"
Valerio Settid8b59372024-07-02 12:02:25 +02006068 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006069 # PAKE functions are still unsupported from PSASIM
6070 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
6071 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
6072 helper_psasim_build client
6073
6074 msg "build test suites"
6075 make PSASIM=1 CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" tests
6076
6077 helper_psasim_server start
6078
Valerio Setti1a493832024-07-01 07:29:02 +02006079 # psasim takes an extremely long execution time on some test suites so we
6080 # exclude them from the list.
6081 SKIP_TEST_SUITES="constant_time_hmac,lmots,lms"
6082 export SKIP_TEST_SUITES
6083
Valerio Setti9022f712024-06-27 07:59:39 +02006084 msg "run test suites"
6085 make PSASIM=1 test
6086
6087 helper_psasim_server kill
6088}
6089
Gilles Peskine192c72f2017-12-21 15:59:21 +01006090################################################################
6091#### Termination
6092################################################################
6093
Gilles Peskine8f073122018-11-27 15:58:47 +01006094post_report () {
6095 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006096 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006097
Gilles Peskine8f073122018-11-27 15:58:47 +01006098 final_report
6099}
6100
6101
6102
6103################################################################
6104#### Run all the things
6105################################################################
6106
Gilles Peskine5d996822020-03-28 21:09:21 +01006107# Function invoked by --error-test to test error reporting.
6108pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006109 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006110 if [ $KEEP_GOING -ne 0 ]; then
6111 echo "Expect three failing commands."
6112 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006113 # If the component doesn't run in a subshell, changing error_test_i to an
6114 # invalid integer will cause an error in the loop that runs this function.
6115 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006116 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006117 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006118 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006119 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006120 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006121 make unknown_target
6122 false "this should not be executed"
6123}
6124
Gilles Peskinee48351a2018-11-27 16:06:30 +01006125# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006126run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006127 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006128 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006129
6130 # Unconditionally create a seedfile that's sufficiently long.
6131 # Do this before each component, because a previous component may
6132 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006133 local dd_cmd
6134 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6135 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006136 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006137 esac
6138 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006139
Gilles Peskineec135542021-08-02 23:14:03 +02006140 # Run the component in a subshell, with error trapping and output
6141 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006142 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006143 # We want to keep running if the subshell fails, so 'set -e' must
6144 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006145 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006146 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006147 (
6148 if [ $QUIET -eq 1 ]; then
6149 # msg() will be silenced, so just print the component name here.
6150 echo "${current_component#component_}"
6151 exec >/dev/null
6152 fi
6153 if [ $KEEP_GOING -eq 1 ]; then
6154 # Keep "set -e" off, and run an ERR trap instead to record failures.
6155 set -E
6156 trap err_trap ERR
6157 fi
6158 # The next line is what runs the component
6159 "$@"
6160 if [ $KEEP_GOING -eq 1 ]; then
6161 trap - ERR
6162 exit $last_failure_status
6163 fi
6164 )
6165 component_status=$?
6166 if [ $KEEP_GOING -eq 1 ]; then
6167 set -e
6168 if [ $component_status -ne 0 ]; then
6169 failure_count=$((failure_count + 1))
6170 fi
6171 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006172
6173 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006174 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006175 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006176}
6177
6178# Preliminary setup
6179pre_check_environment
6180pre_initialize_variables
6181pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006182
Dave Rodgman21900632024-02-26 11:41:19 +00006183setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006184pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006185pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006186pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006187
Gilles Peskine878cf602019-01-06 20:50:38 +00006188build_status=0
6189if [ $KEEP_GOING -eq 1 ]; then
6190 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006191fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006192pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006193pre_print_configuration
6194pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006195cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006196if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006197 pre_generate_files
6198fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006199
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006200# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006201for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006202 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006203done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006204unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006205for component in $RUN_COMPONENTS; do
6206 run_component "component_$component"
6207done
Gilles Peskine8f073122018-11-27 15:58:47 +01006208
6209# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006210post_report