blob: 7e09f18e443379908868ceb73debf67f692fb412 [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
Ronald Cronf37ff7f2024-07-02 07:36:39 +0200334 rm -f pkgconfig/Makefile framework/Makefile
Ronald Cron5cdc22b2024-06-12 10:04:22 +0200335 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
Ronald Cronf37ff7f2024-07-02 07:36:39 +0200338 rm -f tf-psa-crypto/drivers/everest/Makefile
339 rm -f tf-psa-crypto/drivers/p256-m/Makefile
Ronald Cron82803982024-07-02 08:40:24 +0200340 rm -f tf-psa-crypto/drivers/builtin/Makefile
341 rm -f tf-psa-crypto/drivers/builtin/src/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200342
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100343 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
344 rm -rf programs/test/cmake_subproject/build
345 rm -f programs/test/cmake_subproject/Makefile
346 rm -f programs/test/cmake_subproject/cmake_subproject
347
Chris Kayd259e342021-03-25 16:03:25 +0000348 # Remove any artifacts from the component_test_cmake_as_package test.
349 rm -rf programs/test/cmake_package/build
350 rm -f programs/test/cmake_package/Makefile
351 rm -f programs/test/cmake_package/cmake_package
352
353 # Remove any artifacts from the component_test_cmake_as_installed_package test.
354 rm -rf programs/test/cmake_package_install/build
355 rm -f programs/test/cmake_package_install/Makefile
356 rm -f programs/test/cmake_package_install/cmake_package_install
357
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358 # Restore files that may have been clobbered by the job
359 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200360 if [[ -e "$x$backup_suffix" ]]; then
361 cp -p "$x$backup_suffix" "$x"
362 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200363 done
364}
John Durkopbd069d32020-10-31 22:14:03 -0700365
Valerio Setti9022f712024-06-27 07:59:39 +0200366# This is a helper function to be used in psasim builds. It is meant to clean
367# up the library's workspace after the server build and before the client
368# build. Built libraries (mbedcrypto, mbedx509 and mbedtls) are supposed to be
369# already copied to psasim folder at this point.
Valerio Settid8b59372024-07-02 12:02:25 +0200370helper_psasim_cleanup_before_client() {
Valerio Setti9022f712024-06-27 07:59:39 +0200371 # Clean up library files
372 make -C library clean
373 # Clean up intermediate files that were used to build the server
374 make -C $PSASIM_PATH clean_server_intermediate_files
375 # Restore files that were backup before building library files. This
376 # includes $CONFIG_H and $CRYPTO_CONFIG_H.
377 for x in $files_to_back_up; do
378 if [[ -e "$x$backup_suffix" ]]; then
379 cp -p "$x$backup_suffix" "$x"
380 fi
381 done
382}
383
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200384# Final cleanup when this script exits (except when exiting on a failure
385# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200386final_cleanup () {
387 cleanup
388
389 for x in $files_to_back_up; do
390 rm -f "$x$backup_suffix"
391 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100392}
393
Gilles Peskine7c652162017-12-11 00:01:40 +0100394# Executed on exit. May be redefined depending on command line options.
395final_report () {
396 :
397}
398
399fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200400 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100401 final_report $1
402 trap - $1
403 kill -$1 $$
404}
405
406trap 'fatal_signal HUP' HUP
407trap 'fatal_signal INT' INT
408trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200409
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200410# Number of processors on this machine. Used as the default setting
411# for parallel make.
412all_sh_nproc ()
413{
414 {
415 nproc || # Linux
416 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
417 sysctl -n hw.ncpu || # FreeBSD
418 echo 1
419 } 2>/dev/null
420}
421
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100422msg()
423{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100424 if [ -n "${current_component:-}" ]; then
425 current_section="${current_component#component_}: $1"
426 else
427 current_section="$1"
428 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200429
430 if [ $QUIET -eq 1 ]; then
431 return
432 fi
433
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100434 echo ""
435 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100436 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000437 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100438 echo "******************************************************************"
439}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441armc6_build_test()
442{
443 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100444
Gilles Peskine18487f62020-04-30 23:11:54 +0200445 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800446 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100447 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000448 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200449
450 msg "size: ARM Compiler 6 ($FLAGS)"
451 "$ARMC6_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +0200452 "$ARMC6_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +0200453 "$ARMC6_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100454}
Andres AGa5cd9732016-10-17 15:23:10 +0100455
Andres AGd9eba4b2016-08-26 14:42:14 +0100456err_msg()
457{
458 echo "$1" >&2
459}
460
461check_tools()
462{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200463 for tool in "$@"; do
464 if ! `type "$tool" >/dev/null 2>&1`; then
465 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100466 exit 1
467 fi
468 done
469}
470
Gilles Peskine8f073122018-11-27 15:58:47 +0100471pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000472 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100473 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100474 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100475 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200476 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000477 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100478
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000479 # Note that legacy options are ignored instead of being omitted from this
480 # list of options, so invocations that worked with previous version of
481 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100482 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200485 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200486 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000487 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100488 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
489 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100490 --clang-earliest) shift; CLANG_EARLIEST="$1";;
491 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100492 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000493 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100494 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100495 --gcc-earliest) shift; GCC_EARLIEST="$1";;
496 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200498 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
499 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100500 --gnutls-serv) shift; GNUTLS_SERV="$1";;
501 --help|-h) usage; exit;;
502 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000503 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100504 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100505 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200506 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000507 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100508 --no-force) FORCE=0;;
509 --no-keep-going) KEEP_GOING=0;;
510 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200511 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100512 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100513 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200514 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100515 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200516 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100517 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200518 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200519 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100520 --seed|-s) shift; SEED="$1";;
521 -*)
522 echo >&2 "Unknown option: $1"
523 echo >&2 "Run $0 --help for usage."
524 exit 120
525 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000526 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100527 esac
528 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100529 done
SimonB2e23c822016-04-16 21:54:39 +0100530
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100531 # Exclude components that are not supported on this platform.
532 SUPPORTED_COMPONENTS=
533 for component in $ALL_COMPONENTS; do
534 case $(type "support_$component" 2>&1) in
535 *' function'*)
536 if ! support_$component; then continue; fi;;
537 esac
538 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
539 done
540
541 if [ $list_components -eq 1 ]; then
542 printf '%s\n' $SUPPORTED_COMPONENTS
543 exit
544 fi
545
Gilles Peskinea28db922019-01-10 00:05:18 +0100546 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200547 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000548 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100549 fi
550
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000551 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
552 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100553 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000554 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100555 fi
SimonB2e23c822016-04-16 21:54:39 +0100556
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200557 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100558 if [ $all_except -eq 0 ]; then
559 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200560 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
561 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200562 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100563 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200564 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200565 # If the requested name includes a wildcard character, don't
566 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100567 case $component in
568 *[*?\[]*) continue;;
569 esac
570 case " $SUPPORTED_COMPONENTS " in
571 *" $component "*) :;;
572 *)
573 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
574 unsupported=$((unsupported + 1));;
575 esac
576 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200577 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100578 if [ $unsupported -ne 0 ]; then
579 exit 2
580 fi
581 fi
582
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000583 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100584 RUN_COMPONENTS=
585 for component in $SUPPORTED_COMPONENTS; do
586 if is_component_included "$component"; [ $? -eq $all_except ]; then
587 RUN_COMPONENTS="$RUN_COMPONENTS $component"
588 fi
589 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000590
591 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000592 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100593}
SimonB2e23c822016-04-16 21:54:39 +0100594
Gilles Peskine8f073122018-11-27 15:58:47 +0100595pre_check_git () {
596 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100597 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100598 git checkout-index -f -q $CONFIG_H
599 cleanup
600 else
SimonB2e23c822016-04-16 21:54:39 +0100601
Gilles Peskine8f073122018-11-27 15:58:47 +0100602 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
603 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
604 echo "You can either delete this directory manually, or force the test by rerunning"
605 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
606 exit 1
607 fi
608
Ronald Cron7a93ac52023-07-20 09:49:12 +0200609 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100610 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100611 echo "You can either delete or preserve your work, or force the test by rerunning the"
612 echo "script as: $0 --force"
613 exit 1
614 fi
SimonB2e23c822016-04-16 21:54:39 +0100615 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500616}
617
Gilles Peskine568f53a2021-07-12 18:16:01 +0200618pre_restore_files () {
619 # If the makefiles have been generated by a framework such as cmake,
620 # restore them from git. If the makefiles look like modifications from
621 # the ones checked into git, take care not to modify them. Whatever
622 # this function leaves behind is what the script will restore before
623 # each component.
624 case "$(head -n1 Makefile)" in
625 *[Gg]enerated*)
626 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
627 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
628 ;;
629 esac
630}
631
Gilles Peskinef83eb822020-03-30 20:11:39 +0200632pre_back_up () {
633 for x in $files_to_back_up; do
634 cp -p "$x" "$x$backup_suffix"
635 done
636}
637
Gilles Peskine8f073122018-11-27 15:58:47 +0100638pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100639 failure_count=0 # Number of failed components
640 last_failure_status=0 # Last failure status in this component
641
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100642 # See err_trap
643 previous_failure_status=0
644 previous_failed_command=
645 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100646 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100647
Gilles Peskine7c652162017-12-11 00:01:40 +0100648 start_red=
649 end_color=
650 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100651 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100652 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
653 start_red=$(printf '\033[31m')
654 end_color=$(printf '\033[0m')
655 ;;
656 esac
657 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100658
659 # Keep a summary of failures in a file. We'll print it out at the end.
660 failure_summary_file=$PWD/all-sh-failures-$$.log
661 : >"$failure_summary_file"
662
663 # Whether it makes sense to keep a component going after the specified
664 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200665 # This function normally receives the failing simple command
666 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
667 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100668 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200669 # False positives result in running things that can't be expected to
670 # work. False negatives result in things not running after something else
671 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100672 can_keep_going_after_failure () {
673 case "$1" in
674 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200675 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100676 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200677 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
678 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
679 *make*check*) true;;
680 "grep "*) true;;
681 "[ "*) true;;
682 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100683 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100684 esac
685 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100686
687 # This function runs if there is any error in a component.
688 # It must either exit with a nonzero status, or set
689 # last_failure_status to a nonzero value.
690 err_trap () {
691 # Save $? (status of the failing command). This must be the very
692 # first thing, before $? is overridden.
693 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100694 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100695
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100696 if [[ $last_failure_status -eq $previous_failure_status &&
697 "$failed_command" == "$previous_failed_command" &&
698 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
699 then
700 # The same command failed twice in a row, but this time one level
701 # less deep in the function call stack. This happens when the last
702 # command of a function returns a nonzero status, and the function
703 # returns that same status. Ignore the second failure.
704 previous_failure_funcall_depth=${#FUNCNAME[@]}
705 return
706 fi
707 previous_failure_status=$last_failure_status
708 previous_failed_command=$failed_command
709 previous_failure_funcall_depth=${#FUNCNAME[@]}
710
Gilles Peskinece266c42020-03-28 18:50:43 +0100711 text="$current_section: $failed_command -> $last_failure_status"
712 echo "${start_red}^^^^$text^^^^${end_color}" >&2
713 echo "$text" >>"$failure_summary_file"
714
715 # If the command is fatal (configure or build command), stop this
716 # component. Otherwise (test command) keep the component running
717 # (run more tests from the same build).
718 if ! can_keep_going_after_failure "$failed_command"; then
719 exit $last_failure_status
720 fi
721 }
722
Gilles Peskine7c652162017-12-11 00:01:40 +0100723 final_report () {
724 if [ $failure_count -gt 0 ]; then
725 echo
726 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100727 echo "${start_red}FAILED: $failure_count components${end_color}"
728 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100729 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
730 elif [ -z "${1-}" ]; then
731 echo "SUCCESS :)"
732 fi
733 if [ -n "${1-}" ]; then
734 echo "Killed by SIG$1."
735 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100736 rm -f "$failure_summary_file"
737 if [ $failure_count -gt 0 ]; then
738 exit 1
739 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100740 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100741}
742
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200743# record_status() and if_build_succeeded() are kept temporarily for backward
744# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100745record_status () {
746 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100747}
Gilles Peskine7c652162017-12-11 00:01:40 +0100748if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100749 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100750}
751
Gilles Peskinea681c592020-03-28 21:27:40 +0100752# '! true' does not trigger the ERR trap. Arrange to trigger it, with
753# a reasonably informative error message (not just "$@").
754not () {
755 if "$@"; then
756 report_failed_command="! $*"
757 false
758 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200759 fi
760}
761
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200762pre_prepare_outcome_file () {
763 case "$MBEDTLS_TEST_OUTCOME_FILE" in
764 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
765 esac
766 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
767 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
768 fi
769}
770
Gilles Peskine8f073122018-11-27 15:58:47 +0100771pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200772 if [ $QUIET -eq 1 ]; then
773 return
774 fi
775
Gilles Peskine8f073122018-11-27 15:58:47 +0100776 msg "info: $0 configuration"
777 echo "MEMORY: $MEMORY"
778 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200779 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100780 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100781 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100782 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100783 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
784 echo "GNUTLS_CLI: $GNUTLS_CLI"
785 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100786 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
787 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
788}
Andres AG7770ea82016-10-10 15:46:20 +0100789
Andres AGd9eba4b2016-08-26 14:42:14 +0100790# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100791pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000792 # Build the list of variables to pass to output_env.sh.
793 set env
SimonB2e23c822016-04-16 21:54:39 +0100794
Gilles Peskine87964262019-01-06 22:40:00 +0000795 case " $RUN_COMPONENTS " in
796 # Require OpenSSL and GnuTLS if running any tests (as opposed to
797 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
798 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100799 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000800 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
801 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100802 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000803 export GNUTLS_CLI="$GNUTLS_CLI"
804 export GNUTLS_SERV="$GNUTLS_SERV"
805 # Avoid passing --seed flag in every call to ssl-opt.sh
806 if [ -n "${SEED-}" ]; then
807 export SEED
808 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200809 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000810 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200811 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
812 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000813 ;;
814 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200815
Gilles Peskine87964262019-01-06 22:40:00 +0000816 case " $RUN_COMPONENTS " in
817 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
818 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100819
Gilles Peskine87964262019-01-06 22:40:00 +0000820 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200821 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000822 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100823
Gilles Peskine87964262019-01-06 22:40:00 +0000824 case " $RUN_COMPONENTS " in
825 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
826 esac
827
828 case " $RUN_COMPONENTS " in
829 *" test_zeroize "*) check_tools "gdb";;
830 esac
831
832 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000833 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000834 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
835 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200836 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000837 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
838 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200839 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
840 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
841 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000842 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000843
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200844 # past this point, no call to check_tool, only printing output
845 if [ $QUIET -eq 1 ]; then
846 return
847 fi
848
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000849 msg "info: output_env.sh"
850 case $RUN_COMPONENTS in
851 *_armcc*)
852 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
853 *) set "$@" RUN_ARMCC=0;;
854 esac
855 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100856}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100857
Gilles Peskine1570b592021-04-22 01:10:12 +0200858pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200859 # since make doesn't have proper dependencies, remove any possibly outdate
860 # file that might be around before generating fresh ones
861 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200862 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200863 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200864 else
865 make generated_files
866 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200867}
868
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000869clang_version() {
870 if command -v clang > /dev/null ; then
871 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
872 else
873 echo 0 # report version 0 for "no clang"
874 fi
875}
876
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200877################################################################
878#### Helpers for components using libtestdriver1
879################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100880
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200881# How to use libtestdriver1
882# -------------------------
883#
884# 1. Define the list algorithms and key types to accelerate,
885# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
886# Examples:
887# - loc_accel_list="ALG_JPAKE"
888# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200889# 2. Make configurations changes for the driver and/or main libraries.
890# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
891# can be either "default" to start with the default config, or a name
892# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200893# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200894# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
895# These changes affect both the driver and the main libraries.
896# (Note: they need to have the same set of PSA_WANT symbols, as that
897# determines the ABI between them.)
898# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
899# main libraries. Typically, you want to disable the module(s) that are
900# being accelerated. You may need to also disable modules that depend
901# on them or options that are not supported with drivers.
902# 2d. On top of psa/crypto_config.h, the driver library uses its own config
903# file: tests/include/test/drivers/config_test_driver.h. You usually
904# don't need to edit it: using loc_extra_list (see below) is preferred.
905# However, when there's no PSA symbol for what you want to enable,
906# calling scripts/config.py on this file remains the only option.
907# 3. Build the driver library, then the main libraries, test, and programs.
908# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
909# need to enable more algorithms here, typically hash algorithms when
910# accelerating some signature algorithms (ECDSA, RSAv2). This is done
911# by passing a 2nd argument listing the extra algorithms.
912# Example:
913# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
914# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800915# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200916# additional arguments will be passed to make: this can be useful if
917# you don't want to build everything when iterating during development.
918# Example:
919# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
920# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200921
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200922# Adjust the configuration - for both libtestdriver1 and main library,
923# as they should have the same PSA_WANT macros.
924helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200925 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200926 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200927 if [ "$base_config" != "default" ]; then
928 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200929 fi
930
931 # Enable PSA-based config (necessary to use drivers)
932 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
933
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200934 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
935 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
936 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000937
938 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
939 # otherwise we will end up running multithreaded tests without mutexes to protect them.
940 if scripts/config.py get MBEDTLS_THREADING_C; then
941 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
942 fi
943
944 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
945 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
946 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200947}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100948
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100949# Build the drivers library libtestdriver1.a (with ASan).
950#
951# Parameters:
952# 1. a space-separated list of things to accelerate;
953# 2. optional: a space-separate list of things to also support.
954# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
955helper_libtestdriver1_make_drivers() {
956 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
957 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
958}
959
960# Build the main libraries, programs and tests,
961# linking to the drivers library (with ASan).
962#
963# Parameters:
964# 1. a space-separated list of things to accelerate;
965# *. remaining arguments if any are passed directly to make
966# (examples: lib, -C tests test_suite_xxx, etc.)
967# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
968helper_libtestdriver1_make_main() {
969 loc_accel_list=$1
970 shift
971
972 # we need flags both with and without the LIBTESTDRIVER1_ prefix
973 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
974 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
975 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" "$@"
976}
977
Valerio Setti9022f712024-06-27 07:59:39 +0200978# Set some default values $CONFIG_H in order to build server or client sides
979# in PSASIM. There is only 1 mandatory parameter:
980# - $1: target which can be "client" or "server"
Valerio Settid8b59372024-07-02 12:02:25 +0200981helper_psasim_config() {
Valerio Settid1b6ef12024-05-07 16:00:21 +0200982 TARGET=$1
Valerio Settid1b6ef12024-05-07 16:00:21 +0200983
Valerio Settid1b6ef12024-05-07 16:00:21 +0200984 if [ "$TARGET" == "client" ]; then
985 scripts/config.py full
986 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
987 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
988 # Dynamic secure element support is a deprecated feature and it is not
989 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
990 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
991 # Disable potentially problematic features
992 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
993 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
994 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
995 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
996 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100997 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200998 else
999 scripts/config.py crypto_full
1000 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01001001 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
1002 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1003 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
1004 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +02001005 fi
Valerio Setti9022f712024-06-27 07:59:39 +02001006}
Valerio Settid1b6ef12024-05-07 16:00:21 +02001007
Valerio Setti9022f712024-06-27 07:59:39 +02001008# Helper to build the libraries for client/server in PSASIM. If the server is
1009# being built, then it builds also the final executable.
1010# There is only 1 mandatory parameter:
1011# - $1: target which can be "client" or "server"
1012helper_psasim_build() {
1013 TARGET=$1
1014 shift
1015 TARGET_LIB=${TARGET}_libs
1016
1017 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
1018
1019 # Build also the server application after its libraries have been built.
1020 if [ "$TARGET" == "server" ]; then
1021 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_server
1022 fi
Valerio Settid1b6ef12024-05-07 16:00:21 +02001023}
1024
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +01001025################################################################
1026#### Configuration helpers
1027################################################################
1028
Valerio Settib2fd6732023-08-15 17:10:47 +02001029# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +02001030# The function optionally accepts 1 parameter: a space-separated list of the
1031# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +02001032helper_disable_builtin_curves() {
1033 allowed_list="${1:-}"
1034 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
1035
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001036 for curve in $allowed_list; do
1037 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001038 done
1039}
1040
1041# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1042# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1043# in the following helpers.
1044helper_get_psa_curve_list () {
1045 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001046 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1047 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001048 done
1049
1050 echo "$loc_list"
1051}
1052
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001053# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1054# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1055# in the following helpers.
1056helper_get_psa_dh_group_list () {
1057 loc_list=""
1058 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1059 loc_list="$loc_list $item"
1060 done
1061
1062 echo "$loc_list"
1063}
1064
Valerio Settib2fd6732023-08-15 17:10:47 +02001065# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001066# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001067# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001068helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001069 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001070 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001071 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 +02001072 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1073 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001074 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1075 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001076 fi
1077 done
1078
1079 echo "$loc_list"
1080}
1081
Valerio Setti9022f712024-06-27 07:59:39 +02001082# Helper function for controlling (start & stop) the psasim server.
1083helper_psasim_server() {
1084 OPERATION=$1
1085 if [ "$OPERATION" == "start" ]; then
1086 (
1087 cd tests
1088 msg "start server"
1089 psa-client-server/psasim/test/start_server.sh
1090 )
1091 else
1092 (
1093 cd tests
1094 msg "terminate server and cleanup"
1095 psa-client-server/psasim//test/kill_server.sh
1096 )
1097 fi
1098}
1099
Gilles Peskine192c72f2017-12-21 15:59:21 +01001100################################################################
1101#### Basic checks
1102################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001103
Ronald Cron5b41a652024-07-03 08:59:47 +02001104export PSA_CORE_PATH="tf-psa-crypto/core"
Ronald Cron709bbf02024-07-03 07:59:30 +02001105export BUILTIN_SRC_PATH="tf-psa-crypto/drivers/builtin/src"
1106
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001107#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001108# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001109#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001110# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001111# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001112# 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 +02001113# time, so start with a GCC build).
1114# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001115#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001116# Indicative running times are given for reference.
1117
Gilles Peskine8f073122018-11-27 15:58:47 +01001118component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001119 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001120 tests/scripts/recursion.pl library/*.c
Ronald Cron5b41a652024-07-03 08:59:47 +02001121 tests/scripts/recursion.pl ${PSA_CORE_PATH}/*.c
Ronald Cron709bbf02024-07-03 07:59:30 +02001122 tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001123}
Janos Follathb72c6782016-07-19 14:54:17 +01001124
Gilles Peskine67debb62021-05-18 16:09:50 +02001125component_check_generated_files () {
1126 msg "Check: check-generated-files, files generated with make" # 2s
1127 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001128 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001129
1130 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001131 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001132 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001133 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001134
1135 msg "Check: check-generated-files -u, files absent" # 2s
1136 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001137 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001138 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001139 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001140
1141 # This component ends with the generated files present in the source tree.
1142 # This is necessary for subsequent components!
1143}
1144
Gilles Peskine8f073122018-11-27 15:58:47 +01001145component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001146 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001147 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001148}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001149
Gilles Peskine8f073122018-11-27 15:58:47 +01001150component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001151 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001152 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001153}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001154
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001155component_check_changelog () {
1156 msg "Check: changelog entries" # < 1s
1157 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001158 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001159 if [ -e ChangeLog.new ]; then
1160 # Show the diff for information. It isn't an error if the diff is
1161 # non-empty.
1162 diff -u ChangeLog ChangeLog.new || true
1163 rm ChangeLog.new
1164 fi
1165}
1166
Gilles Peskine8f073122018-11-27 15:58:47 +01001167component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001168 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001169 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001170}
Darryl Greena07039c2018-03-13 16:48:16 +00001171
Gilles Peskine895868b2019-09-19 21:30:05 +02001172component_check_test_cases () {
1173 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001174 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001175 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001176 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001177 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001178 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001179 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001180 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001181}
1182
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001183component_check_test_dependencies () {
1184 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001185 # The purpose of this component is to catch unjustified dependencies on
1186 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1187 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1188 # MBEDTLS_PSA_xxx).
1189 #
1190 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1191 # this component is meant to catch. However a few of them are justified,
1192 # mostly by the absence of a PSA equivalent, so this component includes a
1193 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001194
1195 found="check-test-deps-found-$$"
1196 expected="check-test-deps-expected-$$"
1197
1198 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001199 grep 'depends_on' \
1200 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001201 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001202 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001203 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001204
Yanray Wang18040ed2023-11-23 21:29:56 +08001205 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001206 rm -f $expected
1207 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1208 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001209 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1210 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001211 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1212 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001213 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1214 # the test code and that's probably the most convenient way of achieving
1215 # the test's goal.
1216 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1217 # No PSA equivalent - we should probably have one in the future.
1218 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1219 # No PSA equivalent - needed by some init tests
1220 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001221 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001222 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001223
1224 # Compare reality with expectation.
1225 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001226 #
1227 # The output should be empty. When it's not:
1228 # - Each '+' line is a macro that was found but not expected. You want to
1229 # find where that macro occurs, and either replace it with PSA macros, or
1230 # add it to the exceptions list above with a justification.
1231 # - Each '-' line is a macro that was expected but not found; it means the
1232 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001233 diff -U0 $expected $found
1234
1235 rm $found $expected
1236}
1237
Gilles Peskine8f073122018-11-27 15:58:47 +01001238component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001239 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001240 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001241}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001242
Gilles Peskine192c72f2017-12-21 15:59:21 +01001243
Gilles Peskine636c26a2020-03-04 20:46:15 +01001244
Gilles Peskine192c72f2017-12-21 15:59:21 +01001245################################################################
1246#### Build and test many configurations and targets
1247################################################################
1248
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001249component_test_default_out_of_box () {
1250 msg "build: make, default config (out-of-box)" # ~1min
1251 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001252 # Disable fancy stuff
1253 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001254
1255 msg "test: main suites make, default config (out-of-box)" # ~10s
1256 make test
1257
1258 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001259 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001260
1261 msg "program demos: make, default config (out-of-box)" # ~10s
1262 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001263}
1264
Gilles Peskine8f073122018-11-27 15:58:47 +01001265component_test_default_cmake_gcc_asan () {
1266 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001267 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1268 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001269
Gilles Peskine8f073122018-11-27 15:58:47 +01001270 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1271 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001272
Gilles Peskine82b27272019-06-14 18:27:03 +02001273 msg "program demos (ASan build)" # ~10s
1274 tests/scripts/run_demos.py
1275
Gilles Peskine97bea012020-04-23 23:37:45 +02001276 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001277 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001278
Gilles Peskine6848d172023-11-02 19:58:03 +01001279 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001280 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001281
Gilles Peskine8f073122018-11-27 15:58:47 +01001282 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001283 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001284
Gilles Peskine8f073122018-11-27 15:58:47 +01001285 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001286 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001287
1288 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001289 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001290}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001291
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001292component_test_default_cmake_gcc_asan_new_bignum () {
1293 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001294 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001295 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001296 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001297
1298 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1299 make test
1300
1301 msg "test: selftest (ASan build)" # ~ 10s
1302 programs/test/selftest
1303
1304 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1305 tests/ssl-opt.sh
1306
1307 msg "test: compat.sh (ASan build)" # ~ 6 min
1308 tests/compat.sh
1309
1310 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1311 tests/context-info.sh
1312}
1313
Hanno Becker01635512019-02-26 14:27:09 +00001314component_test_full_cmake_gcc_asan () {
1315 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001316 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001317 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1318 make
1319
1320 msg "test: main suites (inc. selftests) (full config, ASan build)"
1321 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001322
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001323 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001324 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001325
Gilles Peskine636c26a2020-03-04 20:46:15 +01001326 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001327 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001328
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001329 # Note: the next two invocations cover all compat.sh test cases.
1330 # We should use the same here and in basic-build-test.sh.
1331 msg "test: compat.sh: default version (full config, ASan build)"
1332 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001333
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001334 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1335 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001336
1337 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001338 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001339}
1340
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001341
1342component_test_full_cmake_gcc_asan_new_bignum () {
1343 msg "build: full config, cmake, gcc, ASan"
1344 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001345 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001346 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001347 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001348
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001349 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001350 make test
1351
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001352 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001353 programs/test/selftest
1354
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001355 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001356 tests/ssl-opt.sh
1357
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001358 # Note: the next two invocations cover all compat.sh test cases.
1359 # We should use the same here and in basic-build-test.sh.
1360 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1361 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001362
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001363 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1364 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001365
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001366 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001367 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001368}
1369
Ronald Cronc3623db2020-10-29 10:51:32 +01001370component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001371 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001372 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001373 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1374 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1375 make
1376
1377 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1378 make test
1379}
1380
David Horstmann4a48bec2024-03-13 15:42:31 +00001381component_test_psa_assume_exclusive_buffers () {
1382 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001383 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001384 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001385 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1386 make
1387
David Horstmann4a48bec2024-03-13 15:42:31 +00001388 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001389 make test
1390}
1391
Gilles Peskinea3548672021-06-17 11:37:52 +02001392# check_renamed_symbols HEADER LIB
1393# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1394# name is LIB.
1395check_renamed_symbols () {
1396 ! nm "$2" | sed 's/.* //' |
1397 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1398}
1399
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001400component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001401 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001402 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001403 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1404 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1405 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1406 # We can only compile, not link, since our test and sample programs
1407 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1408 # is active.
1409 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001410
1411 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1412 # version is not present.
1413 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001414 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001415}
1416
Ryan Everettdaa322a2024-04-18 16:48:55 +01001417component_test_no_rsa_key_pair_generation() {
1418 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001419 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001420 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001421 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001422 make
1423
Ryan Everettdaa322a2024-04-18 16:48:55 +01001424 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001425 make test
1426}
1427
Gilles Peskine782f4112018-11-27 16:11:09 +01001428component_test_ref_configs () {
1429 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001430 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1431 # want to re-generate generated files that depend on it, quite correctly.
1432 # However this doesn't work as the generation script expects a specific
1433 # format for mbedtls_config.h, which the other files don't follow. Also,
1434 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001435 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001436 # whether they're on or off. So, disable cmake's (over-sensitive here)
1437 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001438 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001439 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001440 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001441}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001442
Gilles Peskine8f073122018-11-27 15:58:47 +01001443component_test_no_renegotiation () {
1444 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001445 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001446 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001447 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001448
Gilles Peskine8f073122018-11-27 15:58:47 +01001449 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1450 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001451
Gilles Peskine8f073122018-11-27 15:58:47 +01001452 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001453 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001454}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001455
Gilles Peskine636c26a2020-03-04 20:46:15 +01001456component_test_no_pem_no_fs () {
1457 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1458 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1459 scripts/config.py unset MBEDTLS_FS_IO
1460 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1461 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001462 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001463 make
1464
1465 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1466 make test
1467
1468 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001469 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001470}
1471
Gilles Peskine8f073122018-11-27 15:58:47 +01001472component_test_rsa_no_crt () {
1473 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001474 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001475 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001477
Gilles Peskine8f073122018-11-27 15:58:47 +01001478 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1479 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001480
Gilles Peskine8f073122018-11-27 15:58:47 +01001481 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001482 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001483
Gilles Peskine8f073122018-11-27 15:58:47 +01001484 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001485 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001486
1487 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001488 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001489}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001490
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001491component_test_no_ctr_drbg_classic () {
1492 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001493 scripts/config.py full
1494 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001495 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001496 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497
Dave Rodgman17127e92023-12-14 16:42:48 +00001498 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001499 make
1500
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001501 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001502 make test
1503
Gilles Peskineba749042021-01-13 20:02:03 +01001504 # In this configuration, the TLS test programs use HMAC_DRBG.
1505 # The SSL tests are slow, so run a small subset, just enough to get
1506 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001508 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001509
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001510 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001511 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001512}
1513
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001514component_test_no_ctr_drbg_use_psa () {
1515 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001516 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001517 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1518 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001519
Dave Rodgman17127e92023-12-14 16:42:48 +00001520 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001521 make
1522
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001523 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1524 make test
1525
1526 # In this configuration, the TLS test programs use HMAC_DRBG.
1527 # The SSL tests are slow, so run a small subset, just enough to get
1528 # confidence that the SSL code copes with HMAC_DRBG.
1529 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001530 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001531
1532 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001533 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001534}
1535
1536component_test_no_hmac_drbg_classic () {
1537 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1538 scripts/config.py full
1539 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1540 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1541 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001542 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001543
Dave Rodgman17127e92023-12-14 16:42:48 +00001544 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001545 make
1546
1547 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001548 make test
1549
Gilles Peskinea2224342020-11-19 22:14:34 +01001550 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1551 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1552 # instead.
1553 # Test SSL with non-deterministic ECDSA. Only test features that
1554 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001556 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001557
1558 # To save time, only test one protocol version, since this part of
1559 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001560 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001561 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001562}
1563
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001564component_test_no_hmac_drbg_use_psa () {
1565 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1566 scripts/config.py full
1567 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1568 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1569 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1570
Dave Rodgman17127e92023-12-14 16:42:48 +00001571 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001572 make
1573
1574 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1575 make test
1576
1577 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1578 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1579 # instead.
1580 # Test SSL with non-deterministic ECDSA. Only test features that
1581 # might be affected by how ECDSA signature is performed.
1582 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001583 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584
1585 # To save time, only test one protocol version, since this part of
1586 # the protocol is identical in (D)TLS up to 1.2.
1587 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001588 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001589}
1590
1591component_test_psa_external_rng_no_drbg_classic () {
1592 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1593 scripts/config.py full
1594 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001595 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001596 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001597 scripts/config.py unset MBEDTLS_ENTROPY_C
1598 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1599 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001600 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1601 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1602 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001603 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1604 # the SSL test programs don't have an RNG and can't work. Explicitly
1605 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001606 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001607
1608 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1609 make test
1610
Gilles Peskine8eb29432021-02-03 20:07:11 +01001611 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001612 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001613}
1614
1615component_test_psa_external_rng_no_drbg_use_psa () {
1616 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001617 scripts/config.py full
1618 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001619 scripts/config.py unset MBEDTLS_ENTROPY_C
1620 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1621 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001622 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1623 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1624 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001625 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001626
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001627 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001628 make test
1629
Gilles Peskine8eb29432021-02-03 20:07:11 +01001630 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001631 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001632}
1633
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001634component_test_psa_external_rng_use_psa_crypto () {
1635 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1636 scripts/config.py full
1637 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1638 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1639 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001640 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001641
1642 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1643 make test
1644
1645 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1646 tests/ssl-opt.sh -f 'Default\|opaque'
1647}
1648
Gilles Peskine801c4332023-04-28 21:04:28 +02001649component_test_psa_inject_entropy () {
1650 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1651 scripts/config.py full
1652 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1653 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1654 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1655 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1656 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1657 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001658 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 +02001659
1660 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1661 make test
1662}
1663
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001664component_test_sw_inet_pton () {
1665 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1666
1667 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1668 scripts/config.py set MBEDTLS_TEST_HOOKS
1669 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1670
1671 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1672 make test
1673}
1674
Valerio Settia41654d2024-02-08 10:33:11 +01001675component_full_no_pkparse_pkwrite() {
1676 msg "build: full without pkparse and pkwrite"
1677
1678 scripts/config.py crypto_full
1679 scripts/config.py unset MBEDTLS_PK_PARSE_C
1680 scripts/config.py unset MBEDTLS_PK_WRITE_C
1681
Valerio Settia41654d2024-02-08 10:33:11 +01001682 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1683
1684 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
Ronald Cron709bbf02024-07-03 07:59:30 +02001685 not grep mbedtls_pk_parse_key ${BUILTIN_SRC_PATH}/pkparse.o
1686 not grep mbedtls_pk_write_key_der ${BUILTIN_SRC_PATH}/pkwrite.o
Valerio Settia41654d2024-02-08 10:33:11 +01001687
1688 msg "test: full without pkparse and pkwrite"
1689 make test
1690}
1691
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001692component_test_crypto_full_md_light_only () {
1693 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001694 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001695
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001696 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001697 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001698 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001699 scripts/config.py unset MBEDTLS_HKDF_C
1700 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001701 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001702 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001703 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001704 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001705 # Disable things that would auto-enable MD_C
1706 scripts/config.py unset MBEDTLS_PKCS5_C
1707
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001708 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1709 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001710 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001711
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001712 # Make sure we don't have the HMAC functions, but the hashing functions
Ronald Cron709bbf02024-07-03 07:59:30 +02001713 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1714 grep mbedtls_md ${BUILTIN_SRC_PATH}/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001715
1716 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001717 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001718}
1719
Ronald Cron8dbea482024-05-23 16:04:11 +02001720component_test_full_no_cipher () {
1721 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001722
1723 scripts/config.py full
1724 scripts/config.py unset MBEDTLS_CIPHER_C
1725
Ronald Cron8dbea482024-05-23 16:04:11 +02001726 # The built-in implementation of the following algs/key-types depends
1727 # on CIPHER_C so we disable them.
1728 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1729 # so we keep them enabled.
1730 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1731 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1732 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1733 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1734 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1735 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1736 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1737 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1738 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1739 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1740 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1741
Valerio Settic84d9402023-10-23 14:58:25 +02001742 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001743 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001744 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001745
Gilles Peskine21570cf2023-12-22 11:49:50 +01001746 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001747
Valerio Setti7e710e82023-08-25 09:14:15 +02001748 # Ensure that CIPHER_C was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02001749 not grep mbedtls_cipher_init ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti7e710e82023-08-25 09:14:15 +02001750
Ronald Cron8dbea482024-05-23 16:04:11 +02001751 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001752 make test
1753}
1754
Valerio Settibdfecb62023-11-07 15:37:20 +01001755component_test_full_no_ccm() {
1756 msg "build: full no PSA_WANT_ALG_CCM"
1757
1758 # Full config enables:
1759 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1760 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1761 scripts/config.py full
1762
1763 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1764 # enabled, but not used from TLS since USE_PSA is set.
1765 # This is helpful to ensure that TLS tests below have proper dependencies.
1766 #
1767 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1768 # PSA_WANT_ALG_CCM to be re-enabled.
1769 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1770
Gilles Peskine21570cf2023-12-22 11:49:50 +01001771 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001772
1773 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001774 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001775}
1776
1777component_test_full_no_ccm_star_no_tag() {
1778 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1779
1780 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1781 scripts/config.py full
1782
1783 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1784 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1785 # This basically disables all unauthenticated ciphers on the PSA side, while
1786 # keeping AEADs enabled.
1787 #
1788 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1789 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1790 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1791 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1792 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1793 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1794 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1795 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1796 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1797 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1798
Gilles Peskine21570cf2023-12-22 11:49:50 +01001799 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001800
1801 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Ronald Cron5b41a652024-07-03 08:59:47 +02001802 not grep mbedtls_psa_cipher ${PSA_CORE_PATH}/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001803
1804 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001805 make test
1806}
1807
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001808component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001809 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001810
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001811 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001812 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001813 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001814 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001815 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001816 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1817 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001818 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001819 scripts/config.py unset MBEDTLS_GCM_C
1820 scripts/config.py unset MBEDTLS_CCM_C
1821 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001822 #Disable TLS 1.3 (as no AEAD)
1823 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001824 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1825 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1826 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001827 # 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 +01001828 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001829 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001830 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001831 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001832 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1833 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001834 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001835 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001836 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001837
Przemek Stekiel9550c052022-09-28 09:51:55 +02001838 make
1839
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001840 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001841 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001842
1843 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001844}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001845
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001846component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001847 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001848
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001849 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001850 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001851 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001852 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001853 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001854 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1855 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001856 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001857 scripts/config.py unset MBEDTLS_GCM_C
1858 scripts/config.py unset MBEDTLS_CCM_C
1859 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001860 #Disable TLS 1.3 (as no AEAD)
1861 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001862 # 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 +01001863 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001864 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001865 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001866 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001867 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001868 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001869 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001870 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001871
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001872 make
1873
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001874 msg "test: default with only CBC-legacy cipher use psa"
1875 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001876
1877 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1878 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001879}
1880
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001881component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001882 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001883
1884 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001885 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001886 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001887 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001888 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001889 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1890 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001891 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001892 scripts/config.py unset MBEDTLS_GCM_C
1893 scripts/config.py unset MBEDTLS_CCM_C
1894 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001895 #Disable TLS 1.3 (as no AEAD)
1896 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001897 # 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 +01001898 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001899 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1900 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1901 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001902 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001903 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001904 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001905 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001906
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001907 make
1908
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001909 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001910 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001911
1912 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1913 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001914}
1915
Valerio Setti9f0ec532022-11-08 13:03:24 +01001916# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1917# that we could use for interop testing. However, we now have sort of two
1918# implementations ourselves: one using PSA, the other not. At least test that
1919# these two interoperate with each other.
1920component_test_tls1_2_ecjpake_compatibility() {
1921 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1922 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001923 # Explicitly make lib first to avoid a race condition:
1924 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1925 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001926 make -C programs ssl/ssl_server2 ssl/ssl_client2
1927 cp programs/ssl/ssl_server2 s2_no_use_psa
1928 cp programs/ssl/ssl_client2 c2_no_use_psa
1929
1930 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1931 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1932 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001933 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001934 make -C programs ssl/ssl_server2 ssl/ssl_client2
1935 make -C programs test/udp_proxy test/query_compile_time_config
1936
Valerio Setti70e02902022-12-02 16:21:56 +01001937 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1938 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1939 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1940 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1941 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1942 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1943 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1944 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 +01001945
1946 rm s2_no_use_psa c2_no_use_psa
1947}
1948
Gilles Peskine636c26a2020-03-04 20:46:15 +01001949component_test_everest () {
1950 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001951 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1952 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1953 make
1954
1955 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1956 make test
1957
Gilles Peskine6848d172023-11-02 19:58:03 +01001958 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001959 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001960
Gilles Peskine636c26a2020-03-04 20:46:15 +01001961 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001962 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001963
1964 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1965 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001966 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001967}
1968
Gilles Peskined3beca92020-07-03 00:15:37 +02001969component_test_everest_curve25519_only () {
1970 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001971 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02001972 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1973 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001974 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1975 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
1976 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02001977 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1978 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001979 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001980 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
1981
Gilles Peskined3beca92020-07-03 00:15:37 +02001982 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001983 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001984 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
1985 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02001986
Dave Rodgman17127e92023-12-14 16:42:48 +00001987 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02001988
1989 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1990 make test
1991}
1992
Gilles Peskine8f073122018-11-27 15:58:47 +01001993component_test_small_ssl_out_content_len () {
1994 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001995 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1996 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00001997 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001998 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001999
Gilles Peskine8f073122018-11-27 15:58:47 +01002000 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002001 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002002}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002003
Gilles Peskine8f073122018-11-27 15:58:47 +01002004component_test_small_ssl_in_content_len () {
2005 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002006 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2007 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002008 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002009 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002010
Gilles Peskine8f073122018-11-27 15:58:47 +01002011 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002012 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002013}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002014
Gilles Peskine8f073122018-11-27 15:58:47 +01002015component_test_small_ssl_dtls_max_buffering () {
2016 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002017 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002018 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002019 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002020
Gilles Peskine8f073122018-11-27 15:58:47 +01002021 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002022 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 +01002023}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002024
Gilles Peskine8f073122018-11-27 15:58:47 +01002025component_test_small_mbedtls_ssl_dtls_max_buffering () {
2026 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002027 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002028 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002029 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002030
Gilles Peskine8f073122018-11-27 15:58:47 +01002031 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002032 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002033}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002034
Gilles Peskine75cc7712019-09-06 19:47:17 +02002035component_test_psa_collect_statuses () {
2036 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002037 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002038 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002039 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002040 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002041 rm -f tests/statuses.log
2042}
2043
Gilles Peskine8f073122018-11-27 15:58:47 +01002044component_test_full_cmake_clang () {
2045 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002046 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002047 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 +01002048 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002049
k-stachowiak0291cb72019-06-26 15:52:12 +02002050 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002051 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002052
Gilles Peskineda6017c2022-10-30 21:02:40 +01002053 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2054 programs/test/cpp_dummy_build
2055
Gilles Peskine6848d172023-11-02 19:58:03 +01002056 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002057 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002058
Gilles Peskine82b27272019-06-14 18:27:03 +02002059 msg "program demos (full config, clang)" # ~10s
2060 tests/scripts/run_demos.py
2061
k-stachowiak0291cb72019-06-26 15:52:12 +02002062 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002063 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002064
Gilles Peskine8f073122018-11-27 15:58:47 +01002065 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002066 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002067}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002068
Gilles Peskine0c671602022-11-29 16:01:41 +01002069skip_suites_without_constant_flow () {
2070 # Skip the test suites that don't have any constant-flow annotations.
2071 # This will need to be adjusted if we ever start declaring things as
2072 # secret from macros or functions inside tests/include or tests/src.
2073 SKIP_TEST_SUITES=$(
2074 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2075 sed 's/test_suite_//; s/\.function$//' |
2076 tr '\n' ,)
2077 export SKIP_TEST_SUITES
2078}
2079
Dave Rodgman246210e2023-07-31 18:07:44 +01002080skip_all_except_given_suite () {
2081 # Skip all but the given test suite
2082 SKIP_TEST_SUITES=$(
2083 ls -1 tests/suites/test_suite_*.function |
2084 grep -v $1.function |
2085 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2086 tr '\n' ,)
2087 export SKIP_TEST_SUITES
2088}
2089
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002090component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002091 # This tests both (1) accesses to undefined memory, and (2) branches or
2092 # memory access depending on secret values. To distinguish between those:
2093 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2094 # - or alternatively, change the build type to MemSanDbg, which enables
2095 # origin tracking and nicer stack traces (which are useful for debugging
2096 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002097 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2098 scripts/config.py full
2099 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2100 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2101 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2102 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2103 make
2104
2105 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2106 make test
2107}
2108
2109component_test_memsan_constant_flow_psa () {
2110 # This tests both (1) accesses to undefined memory, and (2) branches or
2111 # memory access depending on secret values. To distinguish between those:
2112 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2113 # - or alternatively, change the build type to MemSanDbg, which enables
2114 # origin tracking and nicer stack traces (which are useful for debugging
2115 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002116 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002117 scripts/config.py full
2118 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2119 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2120 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2121 make
2122
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002123 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002124 make test
2125}
2126
Bence Szépkúti0354d042023-12-06 16:14:37 +01002127component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002128 # This tests both (1) everything that valgrind's memcheck usually checks
2129 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2130 # etc.) and (2) branches or memory access depending on secret values,
2131 # which will be reported as uninitialized memory. To distinguish between
2132 # secret and actually uninitialized:
2133 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2134 # - or alternatively, build with debug info and manually run the offending
2135 # test suite with valgrind --track-origins=yes, then check if the origin
2136 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002137 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2138 scripts/config.py full
2139 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2140 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002141 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002142 cmake -D CMAKE_BUILD_TYPE:String=Release .
2143 make
2144
2145 # this only shows a summary of the results (how many of each type)
2146 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002147 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002148 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002149
2150 # Test asm path in constant time module - by default, it will test the plain C
2151 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2152 msg "test: valgrind asm constant_time"
2153 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2154 skip_all_except_given_suite test_suite_constant_time
2155 cmake -D CMAKE_BUILD_TYPE:String=Release .
2156 make clean
2157 make
2158 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002159}
2160
Bence Szépkúti0354d042023-12-06 16:14:37 +01002161component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002162 # This tests both (1) everything that valgrind's memcheck usually checks
2163 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2164 # etc.) and (2) branches or memory access depending on secret values,
2165 # which will be reported as uninitialized memory. To distinguish between
2166 # secret and actually uninitialized:
2167 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2168 # - or alternatively, build with debug info and manually run the offending
2169 # test suite with valgrind --track-origins=yes, then check if the origin
2170 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002171 msg "build: cmake release GCC, full config with constant flow testing"
2172 scripts/config.py full
2173 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002174 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002175 cmake -D CMAKE_BUILD_TYPE:String=Release .
2176 make
2177
2178 # this only shows a summary of the results (how many of each type)
2179 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002180 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002181 make memcheck
2182}
2183
Janos Follath9338cac2023-10-04 18:55:39 +01002184component_test_tsan () {
2185 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002186 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002187 scripts/config.py set MBEDTLS_THREADING_C
2188 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002189 # Self-tests do not currently use multiple threads.
2190 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002191
Ryan6caf84f2024-03-05 13:57:00 +00002192 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2193 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2194
Janos Follath9338cac2023-10-04 18:55:39 +01002195 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2196 make
2197
2198 msg "test: main suites (TSan)"
2199 make test
2200}
2201
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002202component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002203 # Test that removing the deprecated features from the default
2204 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002205 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2206 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002207 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002208
2209 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2210 make test
2211}
2212
2213component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002214 msg "build: make, full_no_deprecated config" # ~ 30s
2215 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002216 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002217
Gilles Peskine30de2e82020-04-20 21:39:22 +02002218 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002219 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002220
2221 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2222 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002223}
2224
Gilles Peskine8386ea22020-04-30 09:07:29 +02002225component_test_full_no_deprecated_deprecated_warning () {
2226 # Test that there is nothing deprecated in "full_no_deprecated".
2227 # A deprecated feature would trigger a warning (made fatal) from
2228 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002229 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2230 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002231 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2232 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002233 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002234
Gilles Peskine30de2e82020-04-20 21:39:22 +02002235 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002236 make test
2237}
2238
Gilles Peskine8386ea22020-04-30 09:07:29 +02002239component_test_full_deprecated_warning () {
2240 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2241 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002242 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002243 scripts/config.py full
2244 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002245 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002246 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2247 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002248 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002249
Gilles Peskine8386ea22020-04-30 09:07:29 +02002250 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2251 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2252 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002253 # Expect warnings from '#warning' directives in check_config.h and
2254 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002255 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 +01002256
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002257 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2258 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002259
2260 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2261 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002262}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002263
Gilles Peskineec541fe2020-01-31 14:24:14 +01002264# Check that the specified libraries exist and are empty.
2265are_empty_libraries () {
2266 nm "$@" >/dev/null 2>/dev/null
2267 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2268}
2269
2270component_build_crypto_default () {
2271 msg "build: make, crypto only"
2272 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002273 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002274 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002275}
2276
2277component_build_crypto_full () {
2278 msg "build: make, crypto only, full config"
2279 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002280 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002281 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002282}
2283
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002284component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002285 msg "build: make, config for PSA crypto service"
2286 scripts/config.py crypto
2287 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2288 # Disable things that are not needed for just cryptography, to
2289 # reach a configuration that would be typical for a PSA cryptography
2290 # service providing all implemented PSA algorithms.
2291 # System stuff
2292 scripts/config.py unset MBEDTLS_ERROR_C
2293 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002294 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002295 # Crypto stuff with no PSA interface
2296 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002297 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002298 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002299 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002300 scripts/config.py unset MBEDTLS_NIST_KW_C
2301 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2302 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2303 scripts/config.py unset MBEDTLS_PKCS12_C
2304 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002305 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2306 # in PSA code to work with RSA keys. We don't require users to set those:
2307 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002308 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002309 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002310 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002311 make CFLAGS='-O1 -Werror' all test
2312 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2313}
2314
Gilles Peskineec541fe2020-01-31 14:24:14 +01002315component_build_crypto_baremetal () {
2316 msg "build: make, crypto only, baremetal config"
2317 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002318 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002319 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002320}
Daniel Axtens446af202020-09-02 21:30:13 +10002321support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002322 support_build_baremetal "$@"
2323}
2324
2325component_build_baremetal () {
2326 msg "build: make, baremetal config"
2327 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002328 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002329}
2330support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002331 # Older Glibc versions include time.h from other headers such as stdlib.h,
2332 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2333 # problem, Ubuntu 18.04 is ok.
2334 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2335}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002336
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002337# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002338component_test_depends_py_cipher_id () {
2339 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002340 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002341}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002342
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002343component_test_depends_py_cipher_chaining () {
2344 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002345 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002346}
2347
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002348component_test_depends_py_cipher_padding () {
2349 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002350 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002351}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002352
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002353component_test_depends_py_curves () {
2354 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002355 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002356}
2357
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002358component_test_depends_py_hashes () {
2359 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002360 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002361}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002362
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002363component_test_depends_py_kex () {
2364 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002365 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002366}
2367
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002368component_test_depends_py_pkalgs () {
2369 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002370 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002371}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002372
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002373# PSA equivalents of the depends.py tests
2374component_test_depends_py_cipher_id_psa () {
2375 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002376 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002377}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002378
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002379component_test_depends_py_cipher_chaining_psa () {
2380 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002381 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002382}
2383
2384component_test_depends_py_cipher_padding_psa () {
2385 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002386 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002387}
2388
2389component_test_depends_py_curves_psa () {
2390 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002391 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002392}
2393
2394component_test_depends_py_hashes_psa () {
2395 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002396 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002397}
2398
2399component_test_depends_py_kex_psa () {
2400 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002401 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002402}
2403
2404component_test_depends_py_pkalgs_psa () {
2405 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002406 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002407}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002408
Valerio Setti6bed64e2024-01-17 15:21:44 +01002409component_test_psa_crypto_config_ffdh_2048_only () {
2410 msg "build: full config - only DH 2048"
2411
2412 scripts/config.py full
2413
2414 # Disable all DH groups other than 2048.
2415 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2416 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2417 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2418 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2419
2420 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2421
2422 msg "test: full config - only DH 2048"
2423 make test
2424
2425 msg "ssl-opt: full config - only DH 2048"
2426 tests/ssl-opt.sh -f "ffdh"
2427}
2428
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002429component_build_no_pk_rsa_alt_support () {
2430 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2431
2432 scripts/config.py full
2433 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2434 scripts/config.py set MBEDTLS_RSA_C
2435 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2436
2437 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002438 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002439}
2440
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002441component_build_module_alt () {
2442 msg "build: MBEDTLS_XXX_ALT" # ~30s
2443 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002444
2445 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002446 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002447 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002448 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002449 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2450 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002451 # You can only have one threading implementation: alt or pthread, not both.
2452 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002453 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2454 # directly and assumes the implementation works with partial groups.
2455 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002456 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2457 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2458 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002459 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2460 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2461 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002462
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002463 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2464 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2465 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002466
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002467 # We can only compile, not link, since we don't have any implementations
2468 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002469 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002470}
2471
Gilles Peskine64996c32024-01-23 20:25:47 +01002472component_test_no_psa_crypto_full_cmake_asan() {
2473 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2474 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002475 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002476 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002477 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002478 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002479 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002480 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002481 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002482 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002483 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002484 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002485 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002486 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002487
Gilles Peskine64996c32024-01-23 20:25:47 +01002488 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002489 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002490
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002491 # Note: ssl-opt.sh has some test cases that depend on
2492 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2493 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002494 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002495 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002496
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002497 # Note: the next two invocations cover all compat.sh test cases.
2498 # We should use the same here and in basic-build-test.sh.
2499 msg "test: compat.sh: default version (full minus PSA crypto)"
2500 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002501
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002502 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002503 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002504}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002505
Ronald Cron403c15c2021-09-13 09:38:05 +02002506component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002507 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002508
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002509 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002510 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002511 $(helper_get_psa_key_type_list "ECC") \
2512 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002513
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002514 # Configure
2515 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002516
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002517 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002518 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002519
2520 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002521 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002522
2523 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002524 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2525 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2526
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002527 # Build
2528 # -----
2529
2530 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002531 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2532 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002533
2534 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2535
Valerio Setti3fe105b2023-10-30 11:08:12 +01002536 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002537
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002538 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002539 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002540
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002541 # Run the tests
2542 # -------------
2543
Ronald Cron403c15c2021-09-13 09:38:05 +02002544 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2545 make test
2546}
2547
Valerio Setti44b178c2023-03-22 14:02:57 +01002548component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002549 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002550
2551 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002552 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002553 $(helper_get_psa_key_type_list "ECC") \
2554 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002555
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002556 # Configure
2557 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002558
Ronald Cron46ac0652024-03-18 12:39:04 +01002559 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002560 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002561
Valerio Setti44b178c2023-03-22 14:02:57 +01002562 # Disable the module that's accelerated
2563 scripts/config.py unset MBEDTLS_ECDH_C
2564
2565 # Disable things that depend on it
2566 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2567 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2568 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2569 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2570 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2571
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002572 # Build
2573 # -----
2574
2575 helper_libtestdriver1_make_drivers "$loc_accel_list"
2576
Valerio Setti3fe105b2023-10-30 11:08:12 +01002577 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002578
Valerio Setti44b178c2023-03-22 14:02:57 +01002579 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002580 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002581
2582 # Run the tests
2583 # -------------
2584
Valerio Setti44b178c2023-03-22 14:02:57 +01002585 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002586 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002587}
2588
Przemek Stekieldccb2022023-05-11 10:48:50 +02002589component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002590 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002591
2592 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002593 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002594 $(helper_get_psa_key_type_list "DH") \
2595 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002596
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002597 # Configure
2598 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002599
Przemek Stekiel565353e2023-07-05 11:07:07 +02002600 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002601 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002602
2603 # Disable the module that's accelerated
2604 scripts/config.py unset MBEDTLS_DHM_C
2605
2606 # Disable things that depend on it
2607 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2608 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2609
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002610 # Build
2611 # -----
2612
2613 helper_libtestdriver1_make_drivers "$loc_accel_list"
2614
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002615 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002616
2617 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002618 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Przemek Stekieldccb2022023-05-11 10:48:50 +02002619
2620 # Run the tests
2621 # -------------
2622
Gilles Peskine14302ed2023-07-19 19:30:04 +02002623 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002624 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002625
Gilles Peskine14302ed2023-07-19 19:30:04 +02002626 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002627 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002628}
2629
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002630component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002631 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002632
2633 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002634 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002635
2636 # Disable things that are not supported
2637 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2638 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002639 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002640
Gilles Peskine14302ed2023-07-19 19:30:04 +02002641 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002642 make test
2643
Gilles Peskine14302ed2023-07-19 19:30:04 +02002644 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002645 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002646}
2647
Valerio Setti44b178c2023-03-22 14:02:57 +01002648component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002649 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002650
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002651 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002652 $(helper_get_psa_key_type_list "ECC") \
2653 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002654
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002655 # Configure
2656 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002657
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002658 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002659
2660 # Make built-in fallback not available
2661 scripts/config.py unset MBEDTLS_ECJPAKE_C
2662 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2663
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002664 # Build
2665 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002666
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002667 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002668
Valerio Setti3fe105b2023-10-30 11:08:12 +01002669 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002670
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002671 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002672 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002673
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002674 # Run the tests
2675 # -------------
2676
Gilles Peskine14302ed2023-07-19 19:30:04 +02002677 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002678 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002679}
2680
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002681component_test_psa_crypto_config_accel_ecc_some_key_types () {
2682 msg "build: full with accelerated EC algs and some key types"
2683
2684 # Algorithms and key types to accelerate
2685 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2686 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2687 ALG_ECDH \
2688 ALG_JPAKE \
2689 KEY_TYPE_ECC_PUBLIC_KEY \
2690 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2691 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002692 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2693 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002694
2695 # Configure
2696 # ---------
2697
2698 # start with config full for maximum coverage (also enables USE_PSA)
2699 helper_libtestdriver1_adjust_config "full"
2700
2701 # Disable modules that are accelerated - some will be re-enabled
2702 scripts/config.py unset MBEDTLS_ECDSA_C
2703 scripts/config.py unset MBEDTLS_ECDH_C
2704 scripts/config.py unset MBEDTLS_ECJPAKE_C
2705 scripts/config.py unset MBEDTLS_ECP_C
2706
2707 # Disable all curves - those that aren't accelerated should be re-enabled
2708 helper_disable_builtin_curves
2709
2710 # Restartable feature is not yet supported by PSA. Once it will in
2711 # the future, the following line could be removed (see issues
2712 # 6061, 6332 and following ones)
2713 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2714
2715 # this is not supported by the driver API yet
2716 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2717
2718 # Build
2719 # -----
2720
2721 # These hashes are needed for some ECDSA signature tests.
2722 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2723 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2724 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2725
Valerio Setti3fe105b2023-10-30 11:08:12 +01002726 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002727
2728 # ECP should be re-enabled but not the others
Ronald Cron709bbf02024-07-03 07:59:30 +02002729 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2730 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2731 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
2732 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002733
2734 # Run the tests
2735 # -------------
2736
2737 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002738 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002739}
2740
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002741# Run tests with only (non-)Weierstrass accelerated
2742# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002743# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2744# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002745common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002746 weierstrass=$1
2747 if [ $weierstrass -eq 1 ]; then
2748 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002749 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002750 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002751 fi
2752
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002753 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002754
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002755 # Note: Curves are handled in a special way by the libtestdriver machinery,
2756 # so we only want to include them in the accel list when building the main
2757 # libraries, hence the use of a separate variable.
2758 # Note: the following loop is a modified version of
2759 # helper_get_psa_curve_list that only keeps Weierstrass families.
2760 loc_weierstrass_list=""
2761 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002762 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2763 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002764 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002765 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002766 ;;
2767 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002768 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002769 ;;
2770 esac
2771 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002772 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002773 loc_curve_list=$loc_weierstrass_list
2774 else
2775 loc_curve_list=$loc_non_weierstrass_list
2776 fi
2777
Valerio Setti3fe105b2023-10-30 11:08:12 +01002778 # Algorithms and key types to accelerate
2779 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2780 ALG_ECDH \
2781 ALG_JPAKE \
2782 $(helper_get_psa_key_type_list "ECC") \
2783 $loc_curve_list"
2784
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002785 # Configure
2786 # ---------
2787
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002788 # Start with config crypto_full and remove PK_C:
2789 # that's what's supported now, see docs/driver-only-builds.md.
2790 helper_libtestdriver1_adjust_config "crypto_full"
2791 scripts/config.py unset MBEDTLS_PK_C
2792 scripts/config.py unset MBEDTLS_PK_PARSE_C
2793 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002794
2795 # Disable modules that are accelerated - some will be re-enabled
2796 scripts/config.py unset MBEDTLS_ECDSA_C
2797 scripts/config.py unset MBEDTLS_ECDH_C
2798 scripts/config.py unset MBEDTLS_ECJPAKE_C
2799 scripts/config.py unset MBEDTLS_ECP_C
2800
2801 # Disable all curves - those that aren't accelerated should be re-enabled
2802 helper_disable_builtin_curves
2803
2804 # Restartable feature is not yet supported by PSA. Once it will in
2805 # the future, the following line could be removed (see issues
2806 # 6061, 6332 and following ones)
2807 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2808
2809 # this is not supported by the driver API yet
2810 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2811
2812 # Build
2813 # -----
2814
2815 # These hashes are needed for some ECDSA signature tests.
2816 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2817 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2818 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2819
Valerio Settiac7a8092023-10-31 12:23:44 +01002820 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002821
2822 # We expect ECDH to be re-enabled for the missing curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002823 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002824 # We expect ECP to be re-enabled, however the parts specific to the
2825 # families of curves that are accelerated should be ommited.
2826 # - functions with mxz in the name are specific to Montgomery curves
2827 # - ecp_muladd is specific to Weierstrass curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002828 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002829 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002830 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2831 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002832 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002833 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2834 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002835 fi
2836 # We expect ECDSA and ECJPAKE to be re-enabled only when
2837 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002838 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002839 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2840 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002841 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002842 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2843 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002844 fi
2845
2846 # Run the tests
2847 # -------------
2848
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002849 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2850 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002851}
2852
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002853component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002854 common_test_psa_crypto_config_accel_ecc_some_curves 1
2855}
2856
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002857component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002858 common_test_psa_crypto_config_accel_ecc_some_curves 0
2859}
2860
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002861# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2862# ECDH, ECDSA) with and without drivers.
2863# The input parameter is a boolean value which indicates:
2864# - 0 keep built-in EC algs,
2865# - 1 exclude built-in EC algs (driver only).
2866#
2867# This is used by the two following components to ensure they always use the
2868# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002869# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2870# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002871# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002872config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002873 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002874 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002875 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002876 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002877 # Disable modules that are accelerated
2878 scripts/config.py unset MBEDTLS_ECDSA_C
2879 scripts/config.py unset MBEDTLS_ECDH_C
2880 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002881 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002882 fi
2883
2884 # Restartable feature is not yet supported by PSA. Once it will in
2885 # the future, the following line could be removed (see issues
2886 # 6061, 6332 and following ones)
2887 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002888}
2889
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002890# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2891component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002892 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002893
2894 # Algorithms and key types to accelerate
2895 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2896 ALG_ECDH \
2897 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002898 $(helper_get_psa_key_type_list "ECC") \
2899 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002900
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002901 # Configure
2902 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002903
2904 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002905 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002906
Valerio Setti0a342c92023-09-01 09:12:31 +02002907 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002908 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2909 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002910
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002911 # Build
2912 # -----
2913
2914 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002915 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2916 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002917 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2918
Valerio Setti3fe105b2023-10-30 11:08:12 +01002919 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002920
2921 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002922 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
2923 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2924 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
2925 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002926
2927 # Run the tests
2928 # -------------
2929
Gilles Peskine14302ed2023-07-19 19:30:04 +02002930 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002931 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002932
Gilles Peskine14302ed2023-07-19 19:30:04 +02002933 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002934 tests/ssl-opt.sh
2935}
2936
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002937# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2938component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002939 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002940
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002941 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002942
Gilles Peskine21570cf2023-12-22 11:49:50 +01002943 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002944
Gilles Peskine14302ed2023-07-19 19:30:04 +02002945 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002946 make test
2947
Gilles Peskine14302ed2023-07-19 19:30:04 +02002948 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002949 tests/ssl-opt.sh
2950}
2951
Valerio Settie618cb02023-04-12 14:59:16 +02002952# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002953# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2954# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002955# to ensure that both tests use the same underlying configuration when testing
2956# driver's coverage with analyze_outcomes.py.
2957#
2958# This functions accepts 1 boolean parameter as follows:
2959# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2960# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2961# - 0: include built-in implementation of EC algorithms.
2962#
2963# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2964# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002965config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002966 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002967 # start with full config for maximum coverage (also enables USE_PSA)
2968 helper_libtestdriver1_adjust_config "full"
2969
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002970 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002971 # Disable modules that are accelerated
2972 scripts/config.py unset MBEDTLS_ECDSA_C
2973 scripts/config.py unset MBEDTLS_ECDH_C
2974 scripts/config.py unset MBEDTLS_ECJPAKE_C
2975 # Disable ECP module (entirely)
2976 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002977 fi
2978
Valerio Settiaecd32c2023-06-14 10:42:31 +02002979 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2980 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002981 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002982 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002983
Valerio Settie618cb02023-04-12 14:59:16 +02002984 # Restartable feature is not yet supported by PSA. Once it will in
2985 # the future, the following line could be removed (see issues
2986 # 6061, 6332 and following ones)
2987 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002988}
2989
2990# Build and test a configuration where driver accelerates all EC algs while
2991# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2992# side.
2993#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002994# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2995component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002996 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002997
2998 # Algorithms and key types to accelerate
2999 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3000 ALG_ECDH \
3001 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003002 $(helper_get_psa_key_type_list "ECC") \
3003 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003004
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003005 # Configure
3006 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003007
Valerio Settie618cb02023-04-12 14:59:16 +02003008 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003009 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003010 # Disable all the builtin curves. All the required algs are accelerated.
3011 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003012
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003013 # Build
3014 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003015
3016 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003017 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3018 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3019 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003020
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003021 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003022
Valerio Setti3fe105b2023-10-30 11:08:12 +01003023 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003024
3025 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003026 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3027 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3028 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003029 # Also ensure that ECP module was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003030 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003031
3032 # Run the tests
3033 # -------------
3034
Gilles Peskine14302ed2023-07-19 19:30:04 +02003035 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003036 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003037
Gilles Peskine14302ed2023-07-19 19:30:04 +02003038 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003039 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003040}
3041
3042# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003043# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003044# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003045component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003046 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003047
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003048 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003049
Gilles Peskine21570cf2023-12-22 11:49:50 +01003050 make
Valerio Settie618cb02023-04-12 14:59:16 +02003051
Gilles Peskine14302ed2023-07-19 19:30:04 +02003052 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003053 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003054
Gilles Peskine14302ed2023-07-19 19:30:04 +02003055 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003056 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003057}
3058
Valerio Setti4e2f2442023-08-15 10:10:26 +02003059# This is a common configuration helper used directly from:
3060# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3061# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3062# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003063# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003064# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003065# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003066# - this is the reference component of the above
3067# - it still disables RSA and FFDH, but it uses builtin EC algs
3068# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3069# - accelerate all EC and FFDH algs, disable only RSA
3070# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3071# - this is the reference component of the above
3072# - it still disables RSA, but it uses builtin EC and FFDH algs
3073#
3074# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003075# $1: a boolean value which states if we are testing an accelerated scenario
3076# or not.
3077# $2: a string value which states which components are tested. Allowed values
3078# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003079config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003080 driver_only="$1"
3081 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003082 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003083 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003084
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003085 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003086 # Disable modules that are accelerated
3087 scripts/config.py unset MBEDTLS_ECDSA_C
3088 scripts/config.py unset MBEDTLS_ECDH_C
3089 scripts/config.py unset MBEDTLS_ECJPAKE_C
3090 # Disable ECP module (entirely)
3091 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003092 # Also disable bignum
3093 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003094 fi
3095
3096 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3097 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3098 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3099 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3100
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003101 # RSA support is intentionally disabled on this test because RSA_C depends
3102 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003103 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3104 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 +02003105 scripts/config.py unset MBEDTLS_RSA_C
3106 scripts/config.py unset MBEDTLS_PKCS1_V15
3107 scripts/config.py unset MBEDTLS_PKCS1_V21
3108 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3109 # Also disable key exchanges that depend on RSA
3110 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3111 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3112 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3113 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3114 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3115
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003116 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003117 # When testing ECC only, we disable FFDH support, both from builtin and
3118 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003119 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003120 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 +01003121 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003122 scripts/config.py unset MBEDTLS_DHM_C
3123 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3124 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3125 else
3126 # When testing ECC and DH instead, we disable DHM and depending key
3127 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003128 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003129 scripts/config.py unset MBEDTLS_DHM_C
3130 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3131 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3132 fi
3133 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003134
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003135 # Restartable feature is not yet supported by PSA. Once it will in
3136 # the future, the following line could be removed (see issues
3137 # 6061, 6332 and following ones)
3138 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3139}
3140
Valerio Setti4e2f2442023-08-15 10:10:26 +02003141# Common helper used by:
3142# - component_test_psa_crypto_config_accel_ecc_no_bignum
3143# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003144#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003145# The goal is to build and test accelerating either:
3146# - ECC only or
3147# - both ECC and FFDH
3148#
3149# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003150# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3151# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003152common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003153 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003154
Valerio Setti5dfaca42023-09-05 08:48:51 +02003155 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003156 if [ "$test_target" = "ECC_DH" ]; then
3157 accel_text="ECC/FFDH"
3158 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003159 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003160 accel_text="ECC"
3161 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003162 fi
3163
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003164 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003165
3166 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003167 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3168 ALG_ECDH \
3169 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003170 $(helper_get_psa_key_type_list "ECC") \
3171 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003172 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003173 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003174 loc_accel_list="$loc_accel_list \
3175 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003176 $(helper_get_psa_key_type_list "DH") \
3177 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003178 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003179
3180 # Configure
3181 # ---------
3182
3183 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003184 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003185 # Disable all the builtin curves. All the required algs are accelerated.
3186 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003187
3188 # Build
3189 # -----
3190
3191 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003192 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3193 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3194 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003195
3196 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3197
Valerio Setti3fe105b2023-10-30 11:08:12 +01003198 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003199
3200 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003201 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3202 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3203 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003204 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003205 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3206 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3207 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
3208 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003209
3210 # Run the tests
3211 # -------------
3212
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003213 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003214
Gilles Peskine21570cf2023-12-22 11:49:50 +01003215 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003216
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003217 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003218 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003219}
3220
Valerio Setti4e2f2442023-08-15 10:10:26 +02003221# Common helper used by:
3222# - component_test_psa_crypto_config_reference_ecc_no_bignum
3223# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3224#
3225# The goal is to build and test a reference scenario (i.e. with builtin
3226# components) compared to the ones used in
3227# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3228#
3229# It is meant to be used in conjunction with
3230# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3231# coverage analysis in "analyze_outcomes.py" script.
3232common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003233 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003234
Valerio Setti5dfaca42023-09-05 08:48:51 +02003235 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003236 if [ "$test_target" = "ECC_DH" ]; then
3237 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003238 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003239 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003240 fi
3241
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003242 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003243
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003244 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003245
Gilles Peskine21570cf2023-12-22 11:49:50 +01003246 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003247
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003248 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003249 make test
3250
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003251 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003252 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003253}
3254
Valerio Setti4e2f2442023-08-15 10:10:26 +02003255component_test_psa_crypto_config_accel_ecc_no_bignum () {
3256 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3257}
3258
3259component_test_psa_crypto_config_reference_ecc_no_bignum () {
3260 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3261}
3262
3263component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3264 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3265}
3266
3267component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3268 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3269}
3270
Valerio Settiac6d35f2023-08-04 12:49:11 +02003271# Helper for setting common configurations between:
3272# - component_test_tfm_config_p256m_driver_accel_ec()
3273# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003274common_tfm_config () {
3275 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003276 cp configs/config-tfm.h "$CONFIG_H"
3277 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3278 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003279
Yanray Wang73bb2312023-09-25 11:21:15 +08003280 # Other config adjustment to make the tests pass.
3281 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003282 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003283 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3284 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003285
Yanray Wang73bb2312023-09-25 11:21:15 +08003286 # Config adjustment for better test coverage in our environment.
3287 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003288 #
3289 # Enable filesystem I/O for the benefit of PK parse/write tests.
3290 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3291}
3292
Valerio Settiac6d35f2023-08-04 12:49:11 +02003293# Keep this in sync with component_test_tfm_config() as they are both meant
3294# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003295component_test_tfm_config_p256m_driver_accel_ec () {
3296 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3297
3298 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003299
Dave Rodgman897bb772023-11-15 16:34:20 +00003300 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003301 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003302
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003303 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003304 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3305 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3306 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib7e95442023-03-21 11:52:33 +01003307 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003308 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3309 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3310 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
3311 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003312 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003313 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003314
Valerio Setti5e18b902023-12-04 12:07:30 +01003315 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3316 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003317 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003318
Valerio Settib7e95442023-03-21 11:52:33 +01003319 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003320 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003321 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003322}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003323
Valerio Settiac6d35f2023-08-04 12:49:11 +02003324# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3325# they are both meant to be used in analyze_outcomes.py for driver's coverage
3326# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003327component_test_tfm_config() {
3328 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003329
Dave Rodgman897bb772023-11-15 16:34:20 +00003330 # Disable P256M driver, which is on by default, so that analyze_outcomes
3331 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3332 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3333
Valerio Setti52ba0e32023-08-04 12:43:03 +02003334 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003335 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003336
Dave Rodgman897bb772023-11-15 16:34:20 +00003337 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003338 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003339
Valerio Setti5e18b902023-12-04 12:07:30 +01003340 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3341 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003342 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003343
Valerio Setti52ba0e32023-08-04 12:43:03 +02003344 msg "test: TF-M config"
3345 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003346}
3347
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003348# Common helper for component_full_without_ecdhe_ecdsa() and
3349# component_full_without_ecdhe_ecdsa_and_tls13() which:
3350# - starts from the "full" configuration minus the list of symbols passed in
3351# as 1st parameter
3352# - build
3353# - test only TLS (i.e. test_suite_tls and ssl-opt)
3354build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003355 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003356
3357 msg "build: full minus something, test TLS"
3358
3359 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003360 for sym in $symbols_to_disable; do
3361 echo "Disabling $sym"
3362 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003363 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003364
Gilles Peskine21570cf2023-12-22 11:49:50 +01003365 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003366
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003367 msg "test: full minus something, test TLS"
3368 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003369
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003370 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003371 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003372}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003373
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003374component_full_without_ecdhe_ecdsa () {
3375 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003376}
3377
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003378component_full_without_ecdhe_ecdsa_and_tls13 () {
3379 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3380 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003381}
3382
Valerio Setti249b18a2023-06-20 12:08:30 +02003383# This is an helper used by:
3384# - component_test_psa_ecc_key_pair_no_derive
3385# - component_test_psa_ecc_key_pair_no_generate
3386# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3387# enabled, but one. Input arguments are as follows:
3388# - $1 is the key type under test, i.e. ECC/RSA/DH
3389# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003390build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003391 key_type=$1
3392 unset_option=$2
3393 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003394
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003395 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003396 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003397 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3398 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3399
3400 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3401 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003402 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003403
Gilles Peskine21570cf2023-12-22 11:49:50 +01003404 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003405
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003406 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003407 make test
3408}
3409
3410component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003411 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003412}
3413
3414component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003415 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003416}
3417
Pengyu Lve705f572023-12-06 16:38:15 +08003418config_psa_crypto_accel_rsa () {
3419 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003420
Pengyu Lve705f572023-12-06 16:38:15 +08003421 # Start from crypto_full config (no X.509, no TLS)
3422 helper_libtestdriver1_adjust_config "crypto_full"
3423
3424 if [ "$driver_only" -eq 1 ]; then
3425 # Remove RSA support and its dependencies
3426 scripts/config.py unset MBEDTLS_RSA_C
3427 scripts/config.py unset MBEDTLS_PKCS1_V15
3428 scripts/config.py unset MBEDTLS_PKCS1_V21
3429
3430 # We need PEM parsing in the test library as well to support the import
3431 # of PEM encoded RSA keys.
3432 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3433 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3434 fi
3435}
3436
3437component_test_psa_crypto_config_accel_rsa_crypto () {
3438 msg "build: crypto_full with accelerated RSA"
3439
3440 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3441 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3442 KEY_TYPE_RSA_PUBLIC_KEY \
3443 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3444 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3445 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3446 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003447
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003448 # Configure
3449 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003450
Pengyu Lve705f572023-12-06 16:38:15 +08003451 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003452
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003453 # Build
3454 # -----
3455
Pengyu Lve705f572023-12-06 16:38:15 +08003456 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003457 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 +08003458 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003459 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003460
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003461 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003462
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003463 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003464 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003465
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003466 # Run the tests
3467 # -------------
3468
Pengyu Lve705f572023-12-06 16:38:15 +08003469 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003470 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003471}
3472
3473component_test_psa_crypto_config_reference_rsa_crypto () {
3474 msg "build: crypto_full with non-accelerated RSA"
3475
3476 # Configure
3477 # ---------
3478 config_psa_crypto_accel_rsa 0
3479
3480 # Build
3481 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003482 make
Pengyu Lve705f572023-12-06 16:38:15 +08003483
3484 # Run the tests
3485 # -------------
3486 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003487 make test
3488}
3489
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003490# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003491# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003492component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003493 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003494
Valerio Setti4590bc22023-06-13 15:39:23 +02003495 # Create a temporary output file unless there is already one set
3496 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3497 REMOVE_OUTCOME_ON_EXIT="no"
3498 else
3499 REMOVE_OUTCOME_ON_EXIT="yes"
3500 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3501 export MBEDTLS_TEST_OUTCOME_FILE
3502 fi
3503
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003504 # Start from crypto configuration
3505 scripts/config.py crypto
3506
3507 # Remove RSA support and its dependencies
3508 scripts/config.py unset MBEDTLS_PKCS1_V15
3509 scripts/config.py unset MBEDTLS_PKCS1_V21
3510 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3511 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3512 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3513 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3514 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3515 scripts/config.py unset MBEDTLS_RSA_C
3516 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3517
3518 # Enable PSA support
3519 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3520
Valerio Setti01cc88a2023-06-15 11:53:08 +02003521 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003522 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003523 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3524 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3525 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003526
3527 make
3528
Valerio Setti01cc88a2023-06-15 11:53:08 +02003529 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003530 make test
3531
3532 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3533 # performing RSA signature.
3534 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3535 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3536
3537 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3538 rm $MBEDTLS_TEST_OUTCOME_FILE
3539 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003540}
3541
Ronald Cronb2312452021-05-08 14:32:59 +02003542component_test_psa_crypto_config_accel_hash () {
3543 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3544
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003545 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3546 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3547 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003548
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003549 # Configure
3550 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003551
Ronald Cron46ac0652024-03-18 12:39:04 +01003552 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003553 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003554
3555 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003556 scripts/config.py unset MBEDTLS_MD5_C
3557 scripts/config.py unset MBEDTLS_RIPEMD160_C
3558 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003559 scripts/config.py unset MBEDTLS_SHA224_C
3560 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003561 scripts/config.py unset MBEDTLS_SHA384_C
3562 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003563 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003564
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003565 # Build
3566 # -----
3567
3568 helper_libtestdriver1_make_drivers "$loc_accel_list"
3569
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003570 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003571
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003572 # There's a risk of something getting re-enabled via config_psa.h;
3573 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003574 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3575 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3576 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3577 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3578 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003579
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003580 # Run the tests
3581 # -------------
3582
Ronald Cronb2312452021-05-08 14:32:59 +02003583 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3584 make test
3585}
3586
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003587# Auxiliary function to build config for hashes with and without drivers
3588config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003589 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003590 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003591 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003592 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003593 # disable the built-in implementation of hashes
3594 scripts/config.py unset MBEDTLS_MD5_C
3595 scripts/config.py unset MBEDTLS_RIPEMD160_C
3596 scripts/config.py unset MBEDTLS_SHA1_C
3597 scripts/config.py unset MBEDTLS_SHA224_C
3598 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003599 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003600 scripts/config.py unset MBEDTLS_SHA384_C
3601 scripts/config.py unset MBEDTLS_SHA512_C
3602 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003603 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003604 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003605}
3606
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003607# Note that component_test_psa_crypto_config_reference_hash_use_psa
3608# is related to this component and both components need to be kept in sync.
3609# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003610component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003611 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003612
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003613 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3614 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3615 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003616
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003617 # Configure
3618 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003619
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003620 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003621
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003622 # Build
3623 # -----
3624
3625 helper_libtestdriver1_make_drivers "$loc_accel_list"
3626
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003627 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003628
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003629 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003630 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003631 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3632 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3633 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3634 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3635 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003636
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003637 # Run the tests
3638 # -------------
3639
Gilles Peskine14302ed2023-07-19 19:30:04 +02003640 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003641 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003642
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003643 # This is mostly useful so that we can later compare outcome files with
3644 # the reference config in analyze_outcomes.py, to check that the
3645 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003646 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003647 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003648
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003649 # This is to make sure all ciphersuites are exercised, but we don't need
3650 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003651 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003652 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003653}
3654
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003655# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3656# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3657# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3658# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003659component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003660 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003661
3662 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003663
Gilles Peskine21570cf2023-12-22 11:49:50 +01003664 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003665
Gilles Peskine14302ed2023-07-19 19:30:04 +02003666 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003667 make test
3668
Gilles Peskine14302ed2023-07-19 19:30:04 +02003669 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003670 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003671}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003672
Valerio Setti8eb310c2024-01-22 16:22:57 +01003673# Auxiliary function to build config for hashes with and without drivers
3674config_psa_crypto_hmac_use_psa () {
3675 driver_only="$1"
3676 # start with config full for maximum coverage (also enables USE_PSA)
3677 helper_libtestdriver1_adjust_config "full"
3678
Valerio Setticd89b0b2024-01-24 14:24:55 +01003679 if [ "$driver_only" -eq 1 ]; then
3680 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3681 # is still enabled though (for ENTROPY_C among others).
3682 scripts/config.py unset MBEDTLS_MD_C
3683 # Disable also the builtin hashes since they are supported by the driver
3684 # and MD module is able to perform PSA dispathing.
3685 scripts/config.py unset-all MBEDTLS_SHA
3686 scripts/config.py unset MBEDTLS_MD5_C
3687 scripts/config.py unset MBEDTLS_RIPEMD160_C
3688 fi
3689
Valerio Setti8eb310c2024-01-22 16:22:57 +01003690 # Direct dependencies of MD_C. We disable them also in the reference
3691 # component to work with the same set of features.
3692 scripts/config.py unset MBEDTLS_PKCS7_C
3693 scripts/config.py unset MBEDTLS_PKCS5_C
3694 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3695 scripts/config.py unset MBEDTLS_HKDF_C
3696 # Dependencies of HMAC_DRBG
3697 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3698 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3699}
3700
3701component_test_psa_crypto_config_accel_hmac() {
3702 msg "test: full with accelerated hmac"
3703
3704 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3705 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3706 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3707 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3708
3709 # Configure
3710 # ---------
3711
3712 config_psa_crypto_hmac_use_psa 1
3713
Valerio Setti8eb310c2024-01-22 16:22:57 +01003714 # Build
3715 # -----
3716
3717 helper_libtestdriver1_make_drivers "$loc_accel_list"
3718
3719 helper_libtestdriver1_make_main "$loc_accel_list"
3720
3721 # Ensure that built-in support for HMAC is disabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003722 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
Valerio Setti8eb310c2024-01-22 16:22:57 +01003723
3724 # Run the tests
3725 # -------------
3726
3727 msg "test: full with accelerated hmac"
3728 make test
3729}
3730
3731component_test_psa_crypto_config_reference_hmac() {
3732 msg "test: full without accelerated hmac"
3733
3734 config_psa_crypto_hmac_use_psa 0
3735
3736 make
3737
3738 msg "test: full without accelerated hmac"
3739 make test
3740}
3741
Valerio Setti9da01a72023-12-18 17:38:18 +01003742component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003743 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003744
Valerio Setti9da01a72023-12-18 17:38:18 +01003745 # Albeit this components aims at accelerating DES which should only support
3746 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3747 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003748 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3749 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3750 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003751
Valerio Setti9da01a72023-12-18 17:38:18 +01003752 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3753 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3754 # of this component. This limitation will be addressed by #8598.
3755
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003756 # Configure
3757 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003758
Valerio Setti9a427302023-10-17 11:40:42 +02003759 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003760 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003761
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003762 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003763 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3764 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3765 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3766 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3767 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3768 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3769 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003770 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003771
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003772 # Build
3773 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003774
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003775 helper_libtestdriver1_make_drivers "$loc_accel_list"
3776
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003777 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003778
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003779 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003780 not grep mbedtls_des* ${BUILTIN_SRC_PATH}/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003781
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003782 # Run the tests
3783 # -------------
3784
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003785 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003786 make test
3787}
3788
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003789component_test_psa_crypto_config_accel_aead () {
3790 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3791
Valerio Setti3f02bb72023-10-02 15:57:33 +02003792 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3793 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003794
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003795 # Configure
3796 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003797
Valerio Setti3f02bb72023-10-02 15:57:33 +02003798 # Start from full config
3799 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003800
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003801 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003802 scripts/config.py unset MBEDTLS_GCM_C
3803 scripts/config.py unset MBEDTLS_CCM_C
3804 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003805
Valerio Settia50b89e2023-11-08 15:58:47 +01003806 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3807 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003808
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003809 # Build
3810 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003811
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003812 helper_libtestdriver1_make_drivers "$loc_accel_list"
3813
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003814 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003815
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003816 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003817 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3818 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3819 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
Przemek Stekielee1bb412022-10-11 11:52:25 +02003820
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003821 # Run the tests
3822 # -------------
3823
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003824 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3825 make test
3826}
3827
Valerio Settib680fc42023-10-13 09:29:37 +02003828# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003829# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3830# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3831common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003832 # Start from the full config
3833 helper_libtestdriver1_adjust_config "full"
3834
Valerio Settib680fc42023-10-13 09:29:37 +02003835 scripts/config.py unset MBEDTLS_NIST_KW_C
3836}
3837
Valerio Settib6b301f2023-10-04 12:05:05 +02003838# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003839# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3840# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003841# are meant to be used together in analyze_outcomes.py script in order to test
3842# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003843component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3844 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003845
Valerio Settiad8b7f02023-10-25 12:39:50 +02003846 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 +01003847 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003848 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003849 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3850
3851 # Configure
3852 # ---------
3853
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003854 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003855
3856 # Disable the things that are being accelerated
3857 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3858 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3859 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3860 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3861 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3862 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3863 scripts/config.py unset MBEDTLS_GCM_C
3864 scripts/config.py unset MBEDTLS_CCM_C
3865 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003866 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003867 scripts/config.py unset MBEDTLS_DES_C
3868 scripts/config.py unset MBEDTLS_AES_C
3869 scripts/config.py unset MBEDTLS_ARIA_C
3870 scripts/config.py unset MBEDTLS_CHACHA20_C
3871 scripts/config.py unset MBEDTLS_CAMELLIA_C
3872
Valerio Settiec9b2582023-11-08 16:50:54 +01003873 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3874 # does not depend on it.
3875 scripts/config.py unset MBEDTLS_CIPHER_C
3876
Valerio Settib6b301f2023-10-04 12:05:05 +02003877 # Build
3878 # -----
3879
3880 helper_libtestdriver1_make_drivers "$loc_accel_list"
3881
3882 helper_libtestdriver1_make_main "$loc_accel_list"
3883
3884 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003885 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
3886 not grep mbedtls_des ${BUILTIN_SRC_PATH}/des.o
3887 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
3888 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
3889 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
3890 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3891 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3892 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
3893 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003894
3895 # Run the tests
3896 # -------------
3897
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003898 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003899 make test
Valerio Settif9414552023-11-09 10:43:20 +01003900
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003901 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003902 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003903
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003904 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003905 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003906}
3907
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003908component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3909 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3910 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003911
Gilles Peskine21570cf2023-12-22 11:49:50 +01003912 make
Valerio Settif9414552023-11-09 10:43:20 +01003913
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003914 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003915 make test
Valerio Settif9414552023-11-09 10:43:20 +01003916
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003917 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003918 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003919
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003920 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003921 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003922}
3923
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003924common_block_cipher_dispatch() {
3925 TEST_WITH_DRIVER="$1"
3926
3927 # Start from the full config
3928 helper_libtestdriver1_adjust_config "full"
3929
3930 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3931 # Disable key types that are accelerated (there is no legacy equivalent
3932 # symbol for ECB)
3933 scripts/config.py unset MBEDTLS_AES_C
3934 scripts/config.py unset MBEDTLS_ARIA_C
3935 scripts/config.py unset MBEDTLS_CAMELLIA_C
3936 fi
3937
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003938 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003939 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003940 # Keep this also in the reference component in order to skip the same tests
3941 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003942 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
3943 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
3944 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
3945 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
3946 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
3947 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
3948 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02003949 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003950
3951 # Disable direct dependency on AES_C
3952 scripts/config.py unset MBEDTLS_NIST_KW_C
3953
3954 # Prevent the cipher module from using deprecated PSA path. The reason is
3955 # that otherwise there will be tests relying on "aes_info" (defined in
3956 # "cipher_wrap.c") whose functions are not available when AES_C is
3957 # not defined. ARIA and Camellia are not a problem in this case because
3958 # the PSA path is not tested for these key types.
3959 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
3960}
3961
Valerio Settif8e6cba2023-12-12 11:53:39 +01003962component_test_full_block_cipher_psa_dispatch () {
3963 msg "build: full + PSA dispatch in block_cipher"
3964
3965 loc_accel_list="ALG_ECB_NO_PADDING \
3966 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
3967
3968 # Configure
3969 # ---------
3970
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003971 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01003972
Valerio Settif8e6cba2023-12-12 11:53:39 +01003973 # Build
3974 # -----
3975
3976 helper_libtestdriver1_make_drivers "$loc_accel_list"
3977
3978 helper_libtestdriver1_make_main "$loc_accel_list"
3979
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003980 # Make sure disabled components were not re-enabled by accident (additive
3981 # config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003982 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
3983 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
3984 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003985
Valerio Settif8e6cba2023-12-12 11:53:39 +01003986 # Run the tests
3987 # -------------
3988
3989 msg "test: full + PSA dispatch in block_cipher"
3990 make test
3991}
3992
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003993# This is the reference component of component_test_full_block_cipher_psa_dispatch
3994component_test_full_block_cipher_legacy_dispatch () {
3995 msg "build: full + legacy dispatch in block_cipher"
3996
3997 common_block_cipher_dispatch 0
3998
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003999 make
4000
4001 msg "test: full + legacy dispatch in block_cipher"
4002 make test
4003}
4004
Gilles Peskine36dea152023-07-20 22:19:45 +02004005component_test_aead_chachapoly_disabled() {
4006 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004007 scripts/config.py full
4008 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004009 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004010 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004011
Gilles Peskine36dea152023-07-20 22:19:45 +02004012 msg "test: full minus CHACHAPOLY"
4013 make test
4014}
4015
4016component_test_aead_only_ccm() {
4017 msg "build: full minus CHACHAPOLY and GCM"
4018 scripts/config.py full
4019 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4020 scripts/config.py unset MBEDTLS_GCM_C
4021 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4022 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004023 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004024
4025 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004026 make test
4027}
4028
Ronald Crone501d0e2023-07-10 08:31:19 +02004029component_test_ccm_aes_sha256() {
4030 msg "build: CCM + AES + SHA256 configuration"
4031
Ronald Cron7612d8c2023-07-20 10:03:54 +02004032 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004033 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004034
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004035 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004036
4037 msg "test: CCM + AES + SHA256 configuration"
4038 make test
4039}
4040
Dave Rodgman904c5892023-06-28 17:36:02 +01004041support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004042 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004043}
4044
Dave Rodgman904c5892023-06-28 17:36:02 +01004045component_build_tfm_armcc() {
4046 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004047 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004048
Dave Rodgman88651c42023-06-29 12:35:51 +01004049 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004050 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 +01004051}
4052
4053component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004054 # Check that the TF-M configuration can build cleanly with various
4055 # warning flags enabled. We don't build or run tests, since the
4056 # TF-M configuration needs a TF-M platform. A tweaked version of
4057 # the configuration that works on mainstream platforms is in
4058 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004059 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004060
Dave Rodgman88651c42023-06-29 12:35:51 +01004061 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004062 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 +01004063
Dave Rodgman904c5892023-06-28 17:36:02 +01004064 msg "build: TF-M config, gcc native build"
4065 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004066 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 +01004067}
4068
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004069# Test that the given .o file builds with all (valid) combinations of the given options.
4070#
4071# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4072#
4073# The validator function is the name of a function to validate the combination of options.
4074# It may be "" if all combinations are valid.
4075# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004076# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004077build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004078 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004079 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004080 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004081 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004082 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004083
Dave Rodgman42436102023-10-03 15:47:05 +01004084 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004085 for opt in "${options[@]}"; do
4086 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004087 done
4088
Ronald Cron709bbf02024-07-03 07:59:30 +02004089 # enter the library directory
4090 cd library
Dave Rodgman42436102023-10-03 15:47:05 +01004091
Dave Rodgman920343a2023-10-01 18:41:09 +01004092 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004093 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 +01004094
Dave Rodgman42436102023-10-03 15:47:05 +01004095 # Extract the command generated by the Makefile to build the target file.
4096 # This ensures that we have any include paths, macro definitions, etc
4097 # that may be applied by make.
4098 # 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 +01004099 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004100
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004101 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004102 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004103
Dave Rodgman28e38d82023-10-04 11:50:30 +01004104 len=${#options[@]}
Ronald Cron709bbf02024-07-03 07:59:30 +02004105 source_file=../${file%.o}.c
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004106
4107 targets=0
4108 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004109
Dave Rodgman28e38d82023-10-04 11:50:30 +01004110 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004111 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004112 # each bit of $i is used to determine if options[i] will be set or not
4113 target="t"
4114 clang_args=""
4115 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004116 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004117 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004118 clang_args="${clang_args} ${opt}"
4119 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004120 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004121 done
4122
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004123 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004124 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004125 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004126 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004127
Dave Rodgman28e38d82023-10-04 11:50:30 +01004128 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004129 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004130 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004131 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004132
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004133 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004134
Dave Rodgman920343a2023-10-01 18:41:09 +01004135 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004136 make -s -f ${makefile} build_test_config_combos
4137 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004138
4139 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004140 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004141}
4142
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004143validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004144 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004145 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4146 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004147 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004148 fi
4149 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004150 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004151}
4152
4153component_build_aes_variations() {
4154 # 18s - around 90ms per clang invocation on M1 Pro
4155 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004156 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004157 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004158
Yanray Wangbc29aef2023-11-06 11:08:17 +08004159 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004160 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004161
Ronald Cron709bbf02024-07-03 07:59:30 +02004162 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004163 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4164 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004165 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004166 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004167
4168 cd "$MBEDTLS_ROOT_DIR"
4169 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4170
Yanray Wang42be1ba2023-11-23 14:28:47 +08004171 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004172 # manually set or unset those configurations to check
4173 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004174 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4175 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4176 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4177 scripts/config.py unset MBEDTLS_DES_C
4178 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron709bbf02024-07-03 07:59:30 +02004179 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004180 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4181 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004182 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004183 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004184}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004185
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004186component_test_no_platform () {
4187 # Full configuration build, without platform support, file IO and net sockets.
4188 # This should catch missing mbedtls_printf definitions, and by disabling file
4189 # IO, it should catch missing '#include <stdio.h>'
4190 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004191 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004192 scripts/config.py unset MBEDTLS_PLATFORM_C
4193 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004194 scripts/config.py unset MBEDTLS_FS_IO
4195 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004196 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004197 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004198 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004199 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004200 # to re-enable platform integration features otherwise disabled in C99 builds
4201 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004202 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004203}
Gilles Peskine7c652162017-12-11 00:01:40 +01004204
4205component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004206 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004207 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4208 scripts/config.py full
4209 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004210 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4211 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4212 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4213 make
4214}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004215
Gilles Peskine8f073122018-11-27 15:58:47 +01004216component_build_no_ssl_srv () {
4217 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004218 scripts/config.py full
4219 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004220 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004221}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004222
Gilles Peskine8f073122018-11-27 15:58:47 +01004223component_build_no_ssl_cli () {
4224 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004225 scripts/config.py full
4226 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004227 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004228}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004229
Gilles Peskine8f073122018-11-27 15:58:47 +01004230component_build_no_sockets () {
4231 # Note, C99 compliance can also be tested with the sockets support disabled,
4232 # as that requires a POSIX platform (which isn't the same as C99).
4233 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004234 scripts/config.py full
4235 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4236 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4237 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4238}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004239
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004240component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004241 msg "build: default config with memory buffer allocator and backtrace enabled"
4242 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4243 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4244 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004245 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004246 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004247 make
4248
4249 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4250 make test
4251}
4252
4253component_test_memory_buffer_allocator () {
4254 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004255 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4256 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004257 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004258 make
4259
4260 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4261 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004262
4263 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4264 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004265 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004266}
4267
Gilles Peskine8f073122018-11-27 15:58:47 +01004268component_test_no_max_fragment_length () {
4269 # Run max fragment length tests with MFL disabled
4270 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004271 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004272 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004273 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004274
Gilles Peskine8f073122018-11-27 15:58:47 +01004275 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004276 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004277}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004278
Hanno Becker545ced42019-02-19 11:10:48 +00004279component_test_asan_remove_peer_certificate () {
4280 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004281 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004282 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004283 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004284 make
4285
4286 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4287 make test
4288
4289 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004290 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004291
4292 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004293 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004294
4295 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004296 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004297}
4298
Gilles Peskine8f073122018-11-27 15:58:47 +01004299component_test_no_max_fragment_length_small_ssl_out_content_len () {
4300 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004301 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4302 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4303 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004304 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004305 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004306
Gilles Peskine8f073122018-11-27 15:58:47 +01004307 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004308 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004309
4310 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004311 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004312}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004313
Darryl Greenaad82f92019-12-02 10:53:11 +00004314component_test_variable_ssl_in_out_buffer_len () {
4315 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4316 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004317 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004318 make
4319
4320 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4321 make test
4322
4323 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004324 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004325
4326 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004327 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004328}
4329
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004330component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004331 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004332 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004333
Dave Rodgman17127e92023-12-14 16:42:48 +00004334 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004335 make
4336
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004337 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004338 make test
4339
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004340 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004341 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004342
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004343 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004344 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004345}
4346
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004347component_test_ssl_alloc_buffer_and_mfl () {
4348 msg "build: default config with memory buffer allocator and MFL extension"
4349 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4350 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4351 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4352 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4353 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004354 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004355 make
4356
4357 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4358 make test
4359
4360 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 +02004361 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004362}
4363
Gilles Peskine636c26a2020-03-04 20:46:15 +01004364component_test_when_no_ciphersuites_have_mac () {
4365 msg "build: when no ciphersuites have MAC"
Ronald Cron0417a2c2024-05-24 14:22:11 +02004366 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4367 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4368 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4369 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4370 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
4371
Gilles Peskine636c26a2020-03-04 20:46:15 +01004372 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004373 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004374 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron0417a2c2024-05-24 14:22:11 +02004375
Gilles Peskine636c26a2020-03-04 20:46:15 +01004376 make
4377
Ronald Croncd33cd62024-05-27 08:14:27 +02004378 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004379 make test
4380
Ronald Croncd33cd62024-05-27 08:14:27 +02004381 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004382 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004383}
4384
Raoul Strackxa4e86142020-06-15 17:03:13 +02004385component_test_no_date_time () {
4386 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4387 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004388 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004389 make
4390
4391 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4392 make test
4393}
4394
Gilles Peskine8f073122018-11-27 15:58:47 +01004395component_test_platform_calloc_macro () {
4396 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004397 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4398 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4399 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004400 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004401 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004402
Gilles Peskine8f073122018-11-27 15:58:47 +01004403 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4404 make test
4405}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004406
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004407component_test_malloc_0_null () {
4408 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004409 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004410 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 +02004411
4412 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4413 make test
4414
4415 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4416 # Just the calloc selftest. "make test" ran the others as part of the
4417 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004418 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004419
4420 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4421 # Run a subset of the tests. The choice is a balance between coverage
4422 # and time (including time indirectly wasted due to flaky tests).
4423 # The current choice is to skip tests whose description includes
4424 # "proxy", which is an approximation of skipping tests that use the
4425 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004426 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004427}
4428
Dave Rodgman6a08b682023-06-19 11:51:33 +01004429support_test_aesni() {
4430 # Check that gcc targets x86_64 (we can build AESNI), and check for
4431 # AESNI support on the host (we can run AESNI).
4432 #
4433 # The name of this function is possibly slightly misleading, but needs to align
4434 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004435 #
4436 # In principle 32-bit x86 can support AESNI, but our implementation does not
4437 # support 32-bit x86, so we check for x86-64.
4438 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004439 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4440 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004441 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004442}
4443
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004444component_test_aesni () { # ~ 60s
4445 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4446 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4447 #
4448 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4449 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4450 # exercise the plain C impl).
4451
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004452 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004453 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004454 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004455 scripts/config.py set MBEDTLS_HAVE_ASM
4456
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004457 # test the intrinsics implementation
4458 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004459 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004460 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004461 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004462 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004463
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004464 # test the asm implementation
4465 msg "AES tests, test assembly"
4466 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004467 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004468 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004469 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004470
4471 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004472 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004473 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004474 msg "AES tests, plain C"
4475 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004476 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004477 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004478 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004479 not grep -q "AES note: using AESNI" ./programs/test/selftest
4480 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004481
4482 # test the intrinsics implementation
4483 scripts/config.py set MBEDTLS_AESNI_C
4484 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4485 msg "AES tests, test AESNI only"
4486 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004487 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004488 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4489 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004490 grep -q "AES note: using AESNI" ./programs/test/selftest
4491 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004492}
4493
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004494component_test_sha3_variations() {
4495 msg "sha3 loop unroll variations"
4496
4497 # define minimal config sufficient to test SHA3
4498 cat > include/mbedtls/mbedtls_config.h << END
4499 #define MBEDTLS_SELF_TEST
4500 #define MBEDTLS_SHA3_C
4501END
4502
4503 msg "all loops unrolled"
4504 make clean
4505 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"
4506 ./tests/test_suite_shax
4507
4508 msg "all loops rolled up"
4509 make clean
4510 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"
4511 ./tests/test_suite_shax
4512}
4513
Jerry Yub6d39c22023-08-16 15:11:48 +08004514support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004515 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004516}
4517
4518component_test_aesni_m32 () { # ~ 60s
4519 # This tests are duplicated from component_test_aesni for i386 target
4520 #
4521 # AESNI intrinsic code supports i386 and assembly code does not support it.
4522
4523 msg "build: default config with different AES implementations"
4524 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004525 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4526 scripts/config.py set MBEDTLS_HAVE_ASM
4527
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004528 # test the intrinsics implementation with gcc
4529 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004530 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004531 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004532 # check that we built intrinsics - this should be used by default when supported by the compiler
4533 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4534 grep -q "AES note: using AESNI" ./programs/test/selftest
4535 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004536 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4537
4538 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004539 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4540 msg "AES tests, test AESNI only"
4541 make clean
4542 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4543 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4544 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4545 grep -q "AES note: using AESNI" ./programs/test/selftest
4546 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004547 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4548}
4549
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004550support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004551 # clang >= 4 is required to build with target attributes
4552 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004553}
4554
4555component_test_aesni_m32_clang() {
4556
4557 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004558 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4559 scripts/config.py set MBEDTLS_HAVE_ASM
4560
4561 # test the intrinsics implementation with clang
4562 msg "AES tests, test intrinsics (clang)"
4563 make clean
4564 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4565 # check that we built intrinsics - this should be used by default when supported by the compiler
4566 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4567 grep -q "AES note: using AESNI" ./programs/test/selftest
4568 grep -q "AES note: built-in implementation." ./programs/test/selftest
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004569 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4570}
4571
Jerry Yu193cbc02023-08-03 17:06:29 +08004572# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4573component_build_aes_aesce_armcc () {
4574 msg "Build: AESCE test on arm64 platform without plain C."
4575 scripts/config.py baremetal
4576
4577 # armc[56] don't support SHA-512 intrinsics
4578 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4579
4580 # Stop armclang warning about feature detection for A64_CRYPTO.
4581 # With this enabled, the library does build correctly under armclang,
4582 # but in baremetal builds (as tested here), feature detection is
4583 # unavailable, and the user is notified via a #warning. So enabling
4584 # this feature would prevent us from building with -Werror on
4585 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004586 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004587 scripts/config.py set MBEDTLS_HAVE_ASM
4588
4589 msg "AESCE, build with default configuration."
4590 scripts/config.py set MBEDTLS_AESCE_C
4591 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4592 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4593
4594 msg "AESCE, build AESCE only"
4595 scripts/config.py set MBEDTLS_AESCE_C
4596 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4597 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4598}
4599
Dave Rodgman0c584032023-10-08 12:26:54 +01004600support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004601 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004602 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004603}
4604
4605component_build_aes_armce () {
4606 # Test variations of AES with Armv8 crypto extensions
4607 scripts/config.py set MBEDTLS_AESCE_C
4608 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4609
4610 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004611 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 +01004612
4613 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004614 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 +01004615
4616 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004617 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 +01004618
Dave Rodgman5e419372023-10-23 15:30:20 +01004619 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004620
Dave Rodgman5e419372023-10-23 15:30:20 +01004621 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004622 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 +01004623
Dave Rodgman5e419372023-10-23 15:30:20 +01004624 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004625 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 +01004626
Dave Rodgman5e419372023-10-23 15:30:20 +01004627 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004628 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004629
4630 # test for presence of AES instructions
4631 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4632 msg "clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004633 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4634 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004635 msg "clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004636 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4637 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004638 msg "clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004639 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4640 grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004641
4642 # test for absence of AES instructions
4643 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4644 scripts/config.py unset MBEDTLS_AESCE_C
4645 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004646 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4647 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004648 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004649 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4650 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004651 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004652 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4653 not grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004654}
4655
Dave Rodgman9ed18532023-10-05 00:06:47 +01004656support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004657 # clang >= 4 is required to build with SHA extensions
4658 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004659}
4660
Dave Rodgmand9e80832023-10-04 17:17:46 +01004661component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004662 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004663
4664
4665 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004666 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004667 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004668 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 +01004669 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004670 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 +01004671 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004672
Dave Rodgmand9e80832023-10-04 17:17:46 +01004673
Dave Rodgman94a634d2023-10-10 12:59:29 +01004674 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004675 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004676 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004677 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 +01004678 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004679
Dave Rodgman5b89c552023-10-10 14:59:02 +01004680 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004681 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004682 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 +01004683 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004684
Dave Rodgmancd654002023-10-05 09:40:07 +01004685
Dave Rodgman94a634d2023-10-10 12:59:29 +01004686 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004687 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004688 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
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-a72+crypto -marm -std=c99"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004690 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004691 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 +01004692 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004693
Dave Rodgmancd654002023-10-05 09:40:07 +01004694
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004695 # examine the disassembly for presence of SHA instructions
4696 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4697 scripts/config.py set ${opt}
4698 msg "${opt} clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004699 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4700 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004701
4702 msg "${opt} clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004703 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4704 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004705
4706 msg "${opt} clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004707 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4708 grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004709 scripts/config.py unset ${opt}
4710 done
4711
4712
4713 # examine the disassembly for absence of SHA instructions
4714 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004715 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4716 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004717
4718 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004719 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4720 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004721
4722 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004723 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4724 not grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004725}
4726
Jerry Yu193cbc02023-08-03 17:06:29 +08004727support_build_aes_aesce_armcc () {
4728 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004729}
4730
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004731component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004732 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004733 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004734
Dave Rodgmand8d64512023-12-19 12:20:21 +00004735 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004736
4737 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4738 make test
4739}
4740
4741component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4742 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4743 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004744 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004745
Hanno Becker83ebf782017-07-07 12:29:15 +01004746 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004747
4748 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004749 make test
4750}
Gilles Peskine8f073122018-11-27 15:58:47 +01004751
Hanno Becker83ebf782017-07-07 12:29:15 +01004752component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004753 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4754 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004755 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004756 scripts/config.py unset MBEDTLS_AESCE_C
4757
Dave Rodgmand8d64512023-12-19 12:20:21 +00004758 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004759
4760 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004761 make test
4762
4763 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4764 programs/test/selftest
4765}
4766
Matthias Schulz0767fda2024-02-07 10:46:28 +01004767component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004768 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4769 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004770 scripts/config.py unset MBEDTLS_AESNI_C
4771 scripts/config.py unset MBEDTLS_AESCE_C
4772
4773 make CFLAGS='-O2 -Werror -Wall -Wextra'
4774
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004775 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004776 make test
4777}
4778
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004779component_test_aes_fewer_tables () {
4780 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004781 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004782 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004783
Gilles Peskine7c652162017-12-11 00:01:40 +01004784 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004785 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004786}
4787
4788component_test_aes_rom_tables () {
4789 msg "build: default config with AES_ROM_TABLES enabled"
4790 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004791 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004792
4793 msg "test: AES_ROM_TABLES"
4794 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004795}
4796
Gilles Peskine14c3c062018-01-29 21:25:12 +01004797component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004798 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4799 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4800 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004801 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004802
Gilles Peskine8f073122018-11-27 15:58:47 +01004803 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4804 make test
4805}
4806
Yanray Wang49cd4b52023-11-10 11:58:37 +08004807# helper for common_block_cipher_no_decrypt() which:
4808# - enable/disable the list of config options passed from -s/-u respectively.
4809# - build
4810# - test for tests_suite_xxx
4811# - selftest
4812#
4813# Usage: helper_block_cipher_no_decrypt_build_test
4814# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4815# Options: -s set_opts the list of config options to enable
4816# -u unset_opts the list of config options to disable
4817# -c cflags the list of options passed to CFLAGS
4818# -l ldflags the list of options passed to LDFLAGS
4819helper_block_cipher_no_decrypt_build_test () {
4820 while [ $# -gt 0 ]; do
4821 case "$1" in
4822 -s)
4823 shift; local set_opts="$1";;
4824 -u)
4825 shift; local unset_opts="$1";;
4826 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004827 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004828 -l)
4829 shift; local ldflags="$1";;
4830 esac
4831 shift
4832 done
4833 set_opts="${set_opts:-}"
4834 unset_opts="${unset_opts:-}"
4835 cflags="${cflags:-}"
4836 ldflags="${ldflags:-}"
4837
Yanray Wangb2d6e522023-11-13 16:57:47 +08004838 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4839 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004840
4841 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4842 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004843 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004844
4845 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004846 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4847 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4848 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004849 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004850 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004851 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
Ronald Cron709bbf02024-07-03 07:59:30 +02004852 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004853
4854 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4855 make test
4856
4857 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4858 programs/test/selftest
4859}
4860
4861# This is a common configuration function used in:
4862# - component_test_block_cipher_no_decrypt_aesni_legacy()
4863# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4864# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4865# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4866# on x86.
4867common_block_cipher_no_decrypt () {
4868 # test AESNI intrinsics
4869 helper_block_cipher_no_decrypt_build_test \
4870 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004871 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004872
4873 # test AESNI assembly
4874 helper_block_cipher_no_decrypt_build_test \
4875 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004876 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004877
4878 # test AES C implementation
4879 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004880 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004881
4882 # test AESNI intrinsics for i386 target
4883 helper_block_cipher_no_decrypt_build_test \
4884 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004885 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004886 -l "-m32"
4887}
4888
Yanray Wang3ae11992023-11-13 17:32:09 +08004889# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4890# usage: 0: no PSA crypto configuration
4891# 1: use PSA crypto configuration
4892config_block_cipher_no_decrypt () {
4893 use_psa=$1
4894
Yanray Wang66111392023-10-31 18:54:54 +08004895 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004896 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4897 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004898 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004899 scripts/config.py unset MBEDTLS_NIST_KW_C
4900
Yanray Wang3ae11992023-11-13 17:32:09 +08004901 if [ "$use_psa" -eq 1 ]; then
4902 # Enable support for cryptographic mechanisms through the PSA API.
4903 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4904 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4905 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4906 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4907 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4908 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4909 fi
4910}
4911
4912component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004913 # This consistently causes an llvm crash on clang 3.8, so use gcc
4914 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004915 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004916 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004917}
4918
Yanray Wangf1496402023-11-01 18:55:13 +08004919component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004920 # This consistently causes an llvm crash on clang 3.8, so use gcc
4921 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004922 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004923 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004924}
4925
Yanray Wang66111392023-10-31 18:54:54 +08004926support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004927 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08004928}
4929
Yanray Wang66111392023-10-31 18:54:54 +08004930component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08004931 scripts/config.py baremetal
4932
4933 # armc[56] don't support SHA-512 intrinsics
4934 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4935
4936 # Stop armclang warning about feature detection for A64_CRYPTO.
4937 # With this enabled, the library does build correctly under armclang,
4938 # but in baremetal builds (as tested here), feature detection is
4939 # unavailable, and the user is notified via a #warning. So enabling
4940 # this feature would prevent us from building with -Werror on
4941 # armclang. Tracked in #7198.
4942 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4943 scripts/config.py set MBEDTLS_HAVE_ASM
4944
Yanray Wang3ae11992023-11-13 17:32:09 +08004945 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08004946
4947 # test AESCE baremetal build
4948 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08004949 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08004950 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08004951
Yanray Wangef1b04d2023-09-08 11:09:26 +08004952 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004953 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4954 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4955 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wangef1b04d2023-09-08 11:09:26 +08004956 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004957 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004958 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Ronald Cron709bbf02024-07-03 07:59:30 +02004959 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
4960 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08004961}
4962
Gilles Peskine592f5912019-10-07 18:49:32 +02004963component_test_ctr_drbg_aes_256_sha_256 () {
4964 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4965 scripts/config.py full
4966 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4967 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004968 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004969 make
4970
4971 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4972 make test
4973}
4974
4975component_test_ctr_drbg_aes_128_sha_512 () {
4976 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004977 scripts/config.py full
4978 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4979 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00004980 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004981 make
4982
4983 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
4984 make test
4985}
4986
4987component_test_ctr_drbg_aes_128_sha_256 () {
4988 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004989 scripts/config.py full
4990 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4991 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
4992 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004993 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004994 make
4995
4996 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4997 make test
4998}
4999
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005000component_test_se_default () {
5001 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005002 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005003 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005004
5005 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5006 make test
5007}
5008
Steven Cooremand57203d2020-07-16 20:28:59 +02005009component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005010 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005011 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005012 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005013 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5014 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005015 loc_cflags="${loc_cflags} -I../tests/include -O2"
5016
Gilles Peskine21570cf2023-12-22 11:49:50 +01005017 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005018
Gilles Peskine1997f302023-07-26 18:45:20 +02005019 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005020 make test
5021}
5022
Gilles Peskine8f073122018-11-27 15:58:47 +01005023component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005024 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005025 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005026 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005027 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005028}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005029
Gilles Peskinecf740502019-07-03 20:43:05 +02005030component_test_cmake_shared () {
5031 msg "build/test: cmake shared" # ~ 2min
5032 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5033 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005034 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005035 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005036 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005037}
5038
Gilles Peskineec10bf12019-09-20 19:56:06 +02005039test_build_opt () {
5040 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005041 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005042 for opt in "$@"; do
5043 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005044 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005045 # We're confident enough in compilers to not run _all_ the tests,
5046 # but at least run the unit tests. In particular, runs with
5047 # optimizations use inline assembly whereas runs with -O0
5048 # skip inline assembly.
5049 make test # ~30s
5050 make clean
5051 done
5052}
5053
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005054# For FreeBSD we invoke the function by name so this condition is added
5055# to disable the existing test_clang_opt function for linux.
5056if [[ $(uname) != "Linux" ]]; then
5057 component_test_clang_opt () {
5058 scripts/config.py full
5059 test_build_opt 'full config' clang -O0 -Os -O2
5060 }
5061fi
5062
5063component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005064 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005065 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005066}
5067support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005068 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005069}
5070
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005071component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005072 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005073 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005074}
5075support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005076 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005077}
5078
5079component_test_gcc_latest_opt () {
5080 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005081 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005082}
5083support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005084 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005085}
5086
5087component_test_gcc_earliest_opt () {
5088 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005089 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005090}
5091support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005092 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005093}
5094
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005095component_build_mbedtls_config_file () {
5096 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005097 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005098 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005099 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005100 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005101 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5102 make clean
5103
5104 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5105 # In the user config, disable one feature (for simplicity, pick a feature
5106 # that nothing else depends on).
5107 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005108 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005109 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5110
5111 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005112}
5113
Gilles Peskine7d904e72022-04-07 21:59:14 +02005114component_build_psa_config_file () {
5115 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5116 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5117 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5118 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5119 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005120 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005121 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5122 make clean
5123
5124 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005125 # In the user config, disable one feature and its dependencies, which will
5126 # reflect on the mbedtls configuration so we can query it with
5127 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005128 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005129 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005130 scripts/config.py unset MBEDTLS_CMAC_C
5131 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5132 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5133
5134 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005135}
5136
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005137component_build_psa_alt_headers () {
5138 msg "build: make with PSA alt headers" # ~20s
5139
5140 # Generate alternative versions of the substitutable headers with the
5141 # same content except different include guards.
5142 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5143
5144 # Build the library and some programs.
5145 # Don't build the fuzzers to avoid having to go through hoops to set
5146 # a correct include path for programs/fuzz/Makefile.
5147 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
5148 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\"'"
5149
5150 # Check that we're getting the alternative include guards and not the
5151 # original include guards.
5152 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5153 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5154 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5155 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5156}
5157
Dave Rodgman852de3c2023-12-14 14:46:45 +00005158component_test_m32_no_asm () {
5159 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005160 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005161 #
5162 # Note that we require gcc, because clang Asan builds fail to link for
5163 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005164 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005165 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005166 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005167 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005168 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005169
Dave Rodgman852de3c2023-12-14 14:46:45 +00005170 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005171 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005172}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005173support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005174 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005175 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005176 *) false;;
5177 esac
5178}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005179
Gilles Peskineff0aee02021-10-05 09:36:03 +02005180component_test_m32_o2 () {
5181 # Build with optimization, to use the i386 specific inline assembly
5182 # and go faster for tests.
5183 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005184 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005185 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005186 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005187
Gilles Peskineff0aee02021-10-05 09:36:03 +02005188 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005189 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005190
Gilles Peskineff0aee02021-10-05 09:36:03 +02005191 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005192 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005193}
Gilles Peskinecf522222021-10-07 19:25:29 +02005194support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005195 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005196}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005197
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005198component_test_m32_everest () {
5199 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005200 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005201 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005202 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005203
5204 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5205 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005206
5207 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005208 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005209
5210 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5211 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005212 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005213}
5214support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005215 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005216}
5217
Gilles Peskine8f073122018-11-27 15:58:47 +01005218component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005219 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005220 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005221 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005222
5223 msg "test: 64-bit ILP32, make, gcc"
5224 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005225}
Gilles Peskine878cf602019-01-06 20:50:38 +00005226support_test_mx32 () {
5227 case $(uname -m) in
5228 amd64|x86_64) true;;
5229 *) false;;
5230 esac
5231}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005232
Peter Kolbus60c6da22018-12-27 06:59:04 -06005233component_test_min_mpi_window_size () {
5234 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005235 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005236 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005237 make
5238
5239 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5240 make test
5241}
5242
Gilles Peskine8f073122018-11-27 15:58:47 +01005243component_test_have_int32 () {
5244 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005245 scripts/config.py unset MBEDTLS_HAVE_ASM
5246 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005247 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005248 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005249
Gilles Peskine8f073122018-11-27 15:58:47 +01005250 msg "test: gcc, force 32-bit bignum limbs"
5251 make test
5252}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005253
Gilles Peskine8f073122018-11-27 15:58:47 +01005254component_test_have_int64 () {
5255 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005256 scripts/config.py unset MBEDTLS_HAVE_ASM
5257 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005258 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005259 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005260
Gilles Peskine8f073122018-11-27 15:58:47 +01005261 msg "test: gcc, force 64-bit bignum limbs"
5262 make test
5263}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005264
Gabor Mezeie256cc12023-07-26 17:28:48 +02005265component_test_have_int32_cmake_new_bignum () {
5266 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5267 scripts/config.py unset MBEDTLS_HAVE_ASM
5268 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005269 scripts/config.py unset MBEDTLS_AESCE_C
5270 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005271 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005272 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005273
5274 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5275 make test
5276}
5277
Gilles Peskine8f073122018-11-27 15:58:47 +01005278component_test_no_udbl_division () {
5279 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005280 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005281 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005282 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005283
Gilles Peskine8f073122018-11-27 15:58:47 +01005284 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5285 make test
5286}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005287
Gilles Peskine8f073122018-11-27 15:58:47 +01005288component_test_no_64bit_multiplication () {
5289 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005290 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005291 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005292 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005293
Gilles Peskine8f073122018-11-27 15:58:47 +01005294 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5295 make test
5296}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005297
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005298component_test_no_strings () {
5299 msg "build: no strings" # ~10s
5300 scripts/config.py full
5301 # Disable options that activate a large amount of string constants.
5302 scripts/config.py unset MBEDTLS_DEBUG_C
5303 scripts/config.py unset MBEDTLS_ERROR_C
5304 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5305 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005306 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005307
5308 msg "test: no strings" # ~ 10s
5309 make test
5310}
5311
Hanno Beckerc5722d12020-10-09 11:10:42 +01005312component_test_no_x509_info () {
5313 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5314 scripts/config.pl full
5315 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5316 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005317 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005318
5319 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5320 make test
5321
5322 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005323 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005324}
5325
Gilles Peskine8f073122018-11-27 15:58:47 +01005326component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005327 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005328 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005329 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 +02005330
Gilles Peskinee36fe812021-09-01 20:00:33 +02005331 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005332 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005333 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005334 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005335}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005336
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005337component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005338 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005339 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005340 # Build for a target platform that's close to what Debian uses
5341 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005342 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005343 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005344 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005345 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'
5346
Gilles Peskinee36fe812021-09-01 20:00:33 +02005347 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005348 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005349 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005350 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005351}
5352support_build_arm_linux_gnueabi_gcc_arm5vte () {
5353 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5354}
5355
5356component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005357 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005358 scripts/config.py baremetal
5359 # This is an imperfect substitute for
5360 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005361 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005362 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 +02005363
Gilles Peskinee36fe812021-09-01 20:00:33 +02005364 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005365 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005366 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005367 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005368}
5369
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005370component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005371 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5372 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005373 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 +02005374
Gilles Peskinee36fe812021-09-01 20:00:33 +02005375 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005376 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005377 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005378 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005379 for lib in library/*.a; do
5380 echo "$lib:"
5381 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5382 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005383}
5384
Gilles Peskine8f073122018-11-27 15:58:47 +01005385component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005386 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005387 scripts/config.py baremetal
5388 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005389 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 +01005390 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005391 not grep __aeabi_uldiv library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005392 not grep __aeabi_uldiv ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005393 not grep __aeabi_uldiv ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005394}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005395
Gilles Peskine8f073122018-11-27 15:58:47 +01005396component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005397 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005398 scripts/config.py baremetal
5399 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005400 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-std=c99 -Werror -O1 -march=armv6-m -mthumb' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01005401 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005402 not grep __aeabi_lmul library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005403 not grep __aeabi_lmul ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005404 not grep __aeabi_lmul ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005405}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005406
Dave Rodgman8c315f22023-06-02 10:26:24 -04005407component_build_arm_clang_thumb () {
5408 # ~ 30s
5409
5410 scripts/config.py baremetal
5411
5412 msg "build: clang thumb 2, make"
5413 make clean
5414 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5415
5416 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5417 msg "build: clang thumb 1 -O0, make"
5418 make clean
5419 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5420
5421 msg "build: clang thumb 1 -Os, make"
5422 make clean
5423 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5424}
5425
Gilles Peskine8f073122018-11-27 15:58:47 +01005426component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005427 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005428 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005429 # armc[56] don't support SHA-512 intrinsics
5430 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005431
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005432 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5433 scripts/config.py unset MBEDTLS_AESCE_C
5434
Dave Rodgman0fddf822023-03-02 15:32:12 +00005435 # Stop armclang warning about feature detection for A64_CRYPTO.
5436 # With this enabled, the library does build correctly under armclang,
5437 # but in baremetal builds (as tested here), feature detection is
5438 # unavailable, and the user is notified via a #warning. So enabling
5439 # this feature would prevent us from building with -Werror on
5440 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005441 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005442
Hanno Beckerf0762e92022-07-15 12:08:19 +01005443 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005444
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005445 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005446
5447 msg "size: ARM Compiler 5"
5448 "$ARMC5_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005449 "$ARMC5_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005450 "$ARMC5_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine18487f62020-04-30 23:11:54 +02005451
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005452 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005453
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005454 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005455 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005456
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005457 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005458 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5459
5460 # ARM Compiler 6 - Target ARMv7-M+DSP
5461 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005462
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005463 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005464 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005465
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005466 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005467 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005468
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005469 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5470 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5471
Dave Rodgman99318e62023-05-24 12:27:42 +01005472 # ARM Compiler 6 - Target Cortex-M0
5473 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005474
5475 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5476 #
5477 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5478 # that we have in our CI
5479 scripts/config.py set MBEDTLS_AESCE_C
5480 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005481}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005482
Pengyu Lvdf070032023-02-24 16:03:31 +08005483support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005484 armc5_cc="$ARMC5_BIN_DIR/armcc"
5485 armc6_cc="$ARMC6_BIN_DIR/armclang"
5486 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005487}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005488
Ronald Crond2cb7f42024-03-18 12:49:18 +01005489component_test_tls12_only () {
5490 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5491 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5492 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5493 make
5494
5495 msg "test: main suites (inc. selftests) (ASan build)"
5496 make test
5497
5498 msg "test: ssl-opt.sh (ASan build)"
5499 tests/ssl-opt.sh
5500
5501 msg "test: compat.sh (ASan build)"
5502 tests/compat.sh
5503}
5504
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005505component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005506 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005507 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005508 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005509 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5510
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005511 msg "test: TLS 1.3 only, all key exchange modes enabled"
5512 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005513
Ronald Cronc3f43b62022-10-17 17:35:32 +02005514 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5515 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005516}
5517
Ronald Cronc3f43b62022-10-17 17:35:32 +02005518component_test_tls13_only_psk () {
5519 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5520 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5521 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5522 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005523 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005524 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5525 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5526 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5527 scripts/config.py unset MBEDTLS_ECDSA_C
5528 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005529 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005530 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005531 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5532
Ronald Cronc3f43b62022-10-17 17:35:32 +02005533 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5534 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005535
Ronald Cronc3f43b62022-10-17 17:35:32 +02005536 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5537 tests/ssl-opt.sh
5538}
5539
5540component_test_tls13_only_ephemeral () {
5541 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5542 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5543 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005544 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005545 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5546
5547 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5548 cd tests; ./test_suite_ssl; cd ..
5549
5550 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5551 tests/ssl-opt.sh
5552}
5553
Przemek Stekiela01c2422023-06-13 10:46:48 +02005554component_test_tls13_only_ephemeral_ffdh () {
5555 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5556 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5557 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5558 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005559 scripts/config.py unset MBEDTLS_ECDH_C
5560
Przemek Stekiela01c2422023-06-13 10:46:48 +02005561 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5562
5563 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5564 cd tests; ./test_suite_ssl; cd ..
5565
5566 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5567 tests/ssl-opt.sh
5568}
5569
Ronald Cronc3f43b62022-10-17 17:35:32 +02005570component_test_tls13_only_psk_ephemeral () {
5571 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5572 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5573 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5574 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5575 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5576 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5577 scripts/config.py unset MBEDTLS_ECDSA_C
5578 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005579 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005580 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005581 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5582
5583 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5584 cd tests; ./test_suite_ssl; cd ..
5585
5586 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5587 tests/ssl-opt.sh
5588}
5589
Przemek Stekiela01c2422023-06-13 10:46:48 +02005590component_test_tls13_only_psk_ephemeral_ffdh () {
5591 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5592 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5593 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5594 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5595 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5596 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5597 scripts/config.py unset MBEDTLS_ECDSA_C
5598 scripts/config.py unset MBEDTLS_PKCS1_V21
5599 scripts/config.py unset MBEDTLS_PKCS7_C
5600 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005601 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005602 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5603
5604 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5605 cd tests; ./test_suite_ssl; cd ..
5606
5607 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5608 tests/ssl-opt.sh
5609}
5610
Ronald Cronc3f43b62022-10-17 17:35:32 +02005611component_test_tls13_only_psk_all () {
5612 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5613 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5614 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5615 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5616 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5617 scripts/config.py unset MBEDTLS_ECDSA_C
5618 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005619 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005620 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005621 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5622
5623 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5624 cd tests; ./test_suite_ssl; cd ..
5625
5626 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5627 tests/ssl-opt.sh
5628}
5629
5630component_test_tls13_only_ephemeral_all () {
5631 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5632 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005633 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005634 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5635
5636 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5637 cd tests; ./test_suite_ssl; cd ..
5638
5639 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5640 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005641}
5642
Ronald Cron46ac0652024-03-18 12:39:04 +01005643component_test_tls13_no_padding () {
5644 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005645 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005646 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005647 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005648 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005649 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005650 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005651 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005652 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005653}
5654
Ronald Cron6f135e12021-12-08 16:57:54 +01005655component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005656 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005657 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005658 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005659 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005660 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005661 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005662 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005663 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005664 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005665}
5666
Ronald Crondd96c0a2024-04-02 12:34:24 +02005667component_test_full_minus_session_tickets() {
5668 msg "build: full config without session tickets"
5669 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005670 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005671 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005672 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5673 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005674 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005675 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005676 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005677 tests/ssl-opt.sh
5678}
5679
Gilles Peskine8f073122018-11-27 15:58:47 +01005680component_build_mingw () {
5681 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005682 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 +00005683
Gilles Peskine8f073122018-11-27 15:58:47 +01005684 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005685 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 +01005686 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005687
Gilles Peskine8f073122018-11-27 15:58:47 +01005688 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005689 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
5690 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 +01005691 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005692
Pengyu Lv158eead2023-10-19 11:27:05 +08005693 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005694 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005695 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 +01005696 make WINDOWS_BUILD=1 clean
5697}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005698support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005699 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5700 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005701 *) true;;
5702 esac
5703}
Simon Butcher91aef332016-11-17 09:20:50 +00005704
Gilles Peskine8f073122018-11-27 15:58:47 +01005705component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005706 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005707 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005708 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5709 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005710
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005711 msg "test: main suites (MSan)" # ~ 10s
5712 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005713
Gilles Peskine6848d172023-11-02 19:58:03 +01005714 msg "test: metatests (MSan)"
5715 tests/scripts/run-metatests.sh any msan
5716
Gilles Peskine82b27272019-06-14 18:27:03 +02005717 msg "program demos (MSan)" # ~20s
5718 tests/scripts/run_demos.py
5719
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005720 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005721 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005722
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005723 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005724
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005725 if [ "$MEMORY" -gt 0 ]; then
5726 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005727 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005728 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005729}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005730
Bence Szépkúti0354d042023-12-06 16:14:37 +01005731component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005732 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005733 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005734 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5735 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005736
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005737 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005738 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005739
Gilles Peskine636c26a2020-03-04 20:46:15 +01005740 # Optional parts (slow; currently broken on OS X because programs don't
5741 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005742 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005743 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005744 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005745 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005746 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005747
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005748 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005749 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005750 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005751 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005752
5753 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005754 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005755 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005756 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005757}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005758
Bence Szépkúti0354d042023-12-06 16:14:37 +01005759component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005760 msg "build: Release, full (clang)"
5761 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5762 scripts/config.py full
5763 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5764 make
5765
5766 msg "test: main suites, Valgrind (full config)"
5767 make memcheck
5768}
5769
Paul Elliott62dc3922021-11-25 17:29:40 +00005770support_test_cmake_out_of_source () {
5771 distrib_id=""
5772 distrib_ver=""
5773 distrib_ver_minor=""
5774 distrib_ver_major=""
5775
5776 # Attempt to parse lsb-release to find out distribution and version. If not
5777 # found this should fail safe (test is supported).
5778 if [[ -f /etc/lsb-release ]]; then
5779
5780 while read -r lsb_line; do
5781 case "$lsb_line" in
5782 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5783 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5784 esac
5785 done < /etc/lsb-release
5786
5787 distrib_ver_major="${distrib_ver%%.*}"
5788 distrib_ver="${distrib_ver#*.}"
5789 distrib_ver_minor="${distrib_ver%%.*}"
5790 fi
5791
5792 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5793 # processor (as the CI does) can create a race condition whereby the build
5794 # fails to see a generated file, despite that file actually having been
5795 # generated. This problem appears to go away with 18.04 or newer, so make
5796 # the out of source tests unsupported on Ubuntu 16.04.
5797 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5798}
5799
Gilles Peskine8f073122018-11-27 15:58:47 +01005800component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005801 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005802 # generates
5803 make neat
5804
Gilles Peskine8f073122018-11-27 15:58:47 +01005805 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005806 MBEDTLS_ROOT_DIR="$PWD"
5807 mkdir "$OUT_OF_SOURCE_DIR"
5808 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005809 # Note: Explicitly generate files as these are turned off in releases
5810 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005811 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005812
Gilles Peskine8f073122018-11-27 15:58:47 +01005813 msg "test: cmake 'out-of-source' build"
5814 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005815 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005816 # Also ensure that there are no error messages such as
5817 # "No such file or directory", which would indicate that some required
5818 # file is missing (ssl-opt.sh tolerates the absence of some files so
5819 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005820 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005821 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005822 cat ssl-opt.err >&2
5823 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005824 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005825 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005826 cd "$MBEDTLS_ROOT_DIR"
5827 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005828}
Andres AGdc192212016-08-31 17:33:13 +01005829
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005830component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005831 # Remove existing generated files so that we use the ones CMake
5832 # generates
5833 make neat
5834
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005835 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005836 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005837 # Note: Explicitly generate files as these are turned off in releases
5838 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005839 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005840 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005841}
Gilles Peskinea3000992022-02-04 00:21:12 +01005842support_test_cmake_as_subdirectory () {
5843 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005844}
5845
Chris Kayd259e342021-03-25 16:03:25 +00005846component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005847 # Remove existing generated files so that we use the ones CMake
5848 # generates
5849 make neat
5850
Chris Kayd259e342021-03-25 16:03:25 +00005851 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005852 cd programs/test/cmake_package
5853 cmake .
5854 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005855 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005856}
Gilles Peskinea3000992022-02-04 00:21:12 +01005857support_test_cmake_as_package () {
5858 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005859}
5860
5861component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005862 # Remove existing generated files so that we use the ones CMake
5863 # generates
5864 make neat
5865
Chris Kayd259e342021-03-25 16:03:25 +00005866 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005867 cd programs/test/cmake_package_install
5868 cmake .
5869 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005870 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005871}
Gilles Peskinea3000992022-02-04 00:21:12 +01005872support_test_cmake_as_package_install () {
5873 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005874}
5875
David Horstmann20550e32023-01-12 14:17:01 +00005876component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005877 # Make a copy of config file to use for the in-tree test
5878 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005879
5880 MBEDTLS_ROOT_DIR="$PWD"
5881 mkdir "$OUT_OF_SOURCE_DIR"
5882 cd "$OUT_OF_SOURCE_DIR"
5883
David Horstmann969c1452023-01-31 10:34:44 +00005884 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005885 cmake "$MBEDTLS_ROOT_DIR"
5886 make
5887
5888 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5889 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005890 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005891 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5892 make
5893
5894 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5895 # In the user config, disable one feature (for simplicity, pick a feature
5896 # that nothing else depends on).
5897 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5898
5899 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5900 make
5901 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5902
5903 rm -f user_config.h full_config.h
5904
5905 cd "$MBEDTLS_ROOT_DIR"
5906 rm -rf "$OUT_OF_SOURCE_DIR"
5907
5908 # Now repeat the test for an in-tree build:
5909
David Horstmann969c1452023-01-31 10:34:44 +00005910 # Restore config for the in-tree test
5911 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005912
David Horstmann969c1452023-01-31 10:34:44 +00005913 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005914 cmake .
5915 make
5916
5917 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5918 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005919 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005920 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5921 make
5922
5923 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5924 # In the user config, disable one feature (for simplicity, pick a feature
5925 # that nothing else depends on).
5926 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5927
5928 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5929 make
5930 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5931
5932 rm -f user_config.h full_config.h
5933}
5934support_build_cmake_custom_config_file () {
5935 support_test_cmake_out_of_source
5936}
5937
David Horstmann041ed422024-05-10 14:37:48 +01005938component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01005939 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01005940 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
5941 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
5942 make
5943}
5944support_build_cmake_programs_no_testing () {
5945 support_test_cmake_out_of_source
5946}
David Horstmann20550e32023-01-12 14:17:01 +00005947
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005948component_build_zeroize_checks () {
5949 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5950
5951 scripts/config.py full
5952
5953 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00005954 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 +01005955}
5956
5957
Gilles Peskine8f073122018-11-27 15:58:47 +01005958component_test_zeroize () {
5959 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5960 # different combinations of compilers and optimization flags by using an
5961 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5962 # system in all cases that the script fails, so we must manually search the
5963 # output to check whether the pass string is present and no failure strings
5964 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005965
Gilles Peskine4976e822019-01-06 19:52:22 +00005966 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5967 # about a spurious message if Gdb tries and fails, so suppress that.
5968 gdb_disable_aslr=
5969 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
5970 gdb_disable_aslr='set disable-randomization off'
5971 fi
5972
Gilles Peskine8f073122018-11-27 15:58:47 +01005973 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01005974 for compiler in clang gcc; do
5975 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
5976 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005977 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
5978 grep "The buffer was correctly zeroized" test_zeroize.log
5979 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01005980 rm -f test_zeroize.log
5981 make clean
5982 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01005983 done
Gilles Peskine8f073122018-11-27 15:58:47 +01005984}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005985
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005986component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00005987 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005988 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00005989 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005990
5991 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00005992 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005993}
5994
5995support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01005996 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02005997 ver="$(cmake --version)"
5998 ver="${ver#cmake version }"
5999 ver_major="${ver%%.*}"
6000
6001 ver="${ver#*.}"
6002 ver_minor="${ver%%.*}"
6003
6004 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006005}
6006
Gilles Peskinec848d222022-12-09 12:23:35 +01006007component_check_code_style () {
6008 msg "Check C code style"
6009 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006010}
6011
Gilles Peskinec848d222022-12-09 12:23:35 +01006012support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006013 case $(uncrustify --version) in
6014 *0.75.1*) true;;
6015 *) false;;
6016 esac
6017}
6018
Gilles Peskine8f073122018-11-27 15:58:47 +01006019component_check_python_files () {
6020 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006021 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006022}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006023
Joe Subbianid614c0b2021-07-29 11:18:29 +01006024component_check_test_helpers () {
6025 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006026 # unittest writes out mundane stuff like number or tests run on stderr.
6027 # Our convention is to reserve stderr for actual errors, and write
6028 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006029 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006030
Joe Subbiania25ffab2021-08-06 09:41:27 +01006031 msg "unit test: translate_ciphers.py"
6032 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006033}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006034
Valerio Settid9e42512024-05-06 15:59:51 +02006035component_test_psasim() {
Valerio Setti9022f712024-06-27 07:59:39 +02006036 msg "build server library and application"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006037 scripts/config.py crypto
Valerio Settid8b59372024-07-02 12:02:25 +02006038 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006039 helper_psasim_build server
Valerio Settid1b6ef12024-05-07 16:00:21 +02006040
Valerio Settid8b59372024-07-02 12:02:25 +02006041 helper_psasim_cleanup_before_client
Valerio Settif98635c2024-06-10 20:13:13 +02006042
6043 msg "build library for client"
Valerio Settid8b59372024-07-02 12:02:25 +02006044 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006045 helper_psasim_build client
Valerio Settif98635c2024-06-10 20:13:13 +02006046
Valerio Setti5beb2362024-06-24 13:13:17 +02006047 msg "build basic psasim client"
6048 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_base
6049 msg "test basic psasim client"
6050 tests/psa-client-server/psasim/test/run_test.sh psa_client_base
Valerio Settid9e42512024-05-06 15:59:51 +02006051
Valerio Setti5beb2362024-06-24 13:13:17 +02006052 msg "build full psasim client"
6053 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_full
6054 msg "test full psasim client"
6055 tests/psa-client-server/psasim/test/run_test.sh psa_client_full
Valerio Settid9e42512024-05-06 15:59:51 +02006056
Valerio Settid9e42512024-05-06 15:59:51 +02006057 make -C tests/psa-client-server/psasim clean
6058}
Jerry Yud767cc42023-03-31 15:03:55 +08006059
Valerio Setti9022f712024-06-27 07:59:39 +02006060component_test_suite_with_psasim()
6061{
6062 msg "build server library and application"
Valerio Settid8b59372024-07-02 12:02:25 +02006063 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006064 # Modify server's library configuration here (if needed)
6065 helper_psasim_build server
6066
Valerio Settid8b59372024-07-02 12:02:25 +02006067 helper_psasim_cleanup_before_client
Valerio Setti9022f712024-06-27 07:59:39 +02006068
6069 msg "build client library"
Valerio Settid8b59372024-07-02 12:02:25 +02006070 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006071 # PAKE functions are still unsupported from PSASIM
6072 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
6073 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
6074 helper_psasim_build client
6075
6076 msg "build test suites"
6077 make PSASIM=1 CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" tests
6078
6079 helper_psasim_server start
6080
Valerio Setti1a493832024-07-01 07:29:02 +02006081 # psasim takes an extremely long execution time on some test suites so we
6082 # exclude them from the list.
6083 SKIP_TEST_SUITES="constant_time_hmac,lmots,lms"
6084 export SKIP_TEST_SUITES
6085
Valerio Setti9022f712024-06-27 07:59:39 +02006086 msg "run test suites"
6087 make PSASIM=1 test
6088
6089 helper_psasim_server kill
6090}
6091
Gilles Peskine192c72f2017-12-21 15:59:21 +01006092################################################################
6093#### Termination
6094################################################################
6095
Gilles Peskine8f073122018-11-27 15:58:47 +01006096post_report () {
6097 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006098 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006099
Gilles Peskine8f073122018-11-27 15:58:47 +01006100 final_report
6101}
6102
6103
6104
6105################################################################
6106#### Run all the things
6107################################################################
6108
Gilles Peskine5d996822020-03-28 21:09:21 +01006109# Function invoked by --error-test to test error reporting.
6110pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006111 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006112 if [ $KEEP_GOING -ne 0 ]; then
6113 echo "Expect three failing commands."
6114 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006115 # If the component doesn't run in a subshell, changing error_test_i to an
6116 # invalid integer will cause an error in the loop that runs this function.
6117 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006118 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006119 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006120 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006121 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006122 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006123 make unknown_target
6124 false "this should not be executed"
6125}
6126
Gilles Peskinee48351a2018-11-27 16:06:30 +01006127# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006128run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006129 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006130 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006131
6132 # Unconditionally create a seedfile that's sufficiently long.
6133 # Do this before each component, because a previous component may
6134 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006135 local dd_cmd
6136 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6137 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006138 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006139 esac
6140 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006141
Gilles Peskineec135542021-08-02 23:14:03 +02006142 # Run the component in a subshell, with error trapping and output
6143 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006144 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006145 # We want to keep running if the subshell fails, so 'set -e' must
6146 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006147 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006148 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006149 (
6150 if [ $QUIET -eq 1 ]; then
6151 # msg() will be silenced, so just print the component name here.
6152 echo "${current_component#component_}"
6153 exec >/dev/null
6154 fi
6155 if [ $KEEP_GOING -eq 1 ]; then
6156 # Keep "set -e" off, and run an ERR trap instead to record failures.
6157 set -E
6158 trap err_trap ERR
6159 fi
6160 # The next line is what runs the component
6161 "$@"
6162 if [ $KEEP_GOING -eq 1 ]; then
6163 trap - ERR
6164 exit $last_failure_status
6165 fi
6166 )
6167 component_status=$?
6168 if [ $KEEP_GOING -eq 1 ]; then
6169 set -e
6170 if [ $component_status -ne 0 ]; then
6171 failure_count=$((failure_count + 1))
6172 fi
6173 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006174
6175 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006176 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006177 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006178}
6179
6180# Preliminary setup
6181pre_check_environment
6182pre_initialize_variables
6183pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006184
Dave Rodgman21900632024-02-26 11:41:19 +00006185setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006186pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006187pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006188pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006189
Gilles Peskine878cf602019-01-06 20:50:38 +00006190build_status=0
6191if [ $KEEP_GOING -eq 1 ]; then
6192 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006193fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006194pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006195pre_print_configuration
6196pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006197cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006198if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006199 pre_generate_files
6200fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006201
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006202# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006203for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006204 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006205done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006206unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006207for component in $RUN_COMPONENTS; do
6208 run_component "component_$component"
6209done
Gilles Peskine8f073122018-11-27 15:58:47 +01006210
6211# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006212post_report