blob: 599b4f7d7d292d9acf19cc52f35c3a563c952631 [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
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000220 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100221 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100222}
Andres AG38495a32016-07-12 16:54:33 +0100223
Dave Rodgman21900632024-02-26 11:41:19 +0000224setup_quiet_wrappers()
225{
226 # Pick up "quiet" wrappers for make and cmake, which don't output very much
227 # unless there is an error. This reduces logging overhead in the CI.
228 #
229 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000230 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
231 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000232 fi
233}
234
Gilles Peskinea28db922019-01-10 00:05:18 +0100235# Test whether the component $1 is included in the command line patterns.
236is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100237{
Gilles Peskine03af6782021-08-06 11:35:17 +0200238 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
239 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100240 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000241 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100242 set +f
243 case ${1#component_} in $pattern) return 0;; esac
244 done
245 set +f
246 return 1
247}
Andres AG7770ea82016-10-10 15:46:20 +0100248
Simon Butcher41eeccf2016-09-07 00:07:09 +0100249usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100250{
Gilles Peskine709346a2017-12-10 23:43:39 +0100251 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100252Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100253Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100254By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100255COMPONENT can be the name of a component or a shell wildcard pattern.
256
257Examples:
258 $0 "check_*"
259 Run all sanity checks.
260 $0 --no-armcc --except test_memsan
261 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100262
263Special options:
264 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000265 --list-all-components List all available test components and exit.
266 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100267
268General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200269 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100270 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100271 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100272 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200273 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200274 --arm-none-eabi-gcc-prefix=<string>
275 Prefix for a cross-compiler for arm-none-eabi
276 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200277 --arm-linux-gnueabi-gcc-prefix=<string>
278 Prefix for a cross-compiler for arm-linux-gnueabi
279 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100280 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200281 --restore First clean up the build tree, restoring backed up
282 files. Do not run any components unless they are
283 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100284 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200285 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100286 --except Exclude the COMPONENTs listed on the command line,
287 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200288 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100289 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100290 --no-force Refuse to overwrite modified files (default).
291 --no-keep-going Stop at the first error (default).
292 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800293 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100294 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200295 --outcome-file=<path> File where test outcomes are written (not done if
296 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100297 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200298 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100299 -s|--seed Integer seed value to use for this test run.
300
301Tool path options:
302 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
303 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100304 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
305 --clang-latest=<Clang_latest_path> Latest version of clang available
306 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
307 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100308 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
309 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100310 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100311 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100312EOF
SimonB2e23c822016-04-16 21:54:39 +0100313}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100314
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200315# Cleanup before/after running a component.
316# Remove built files as well as the cmake cache/config.
317# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100318cleanup()
319{
David Horstmann76a77382023-08-17 17:32:26 +0100320 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100321 command make clean
322 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200323
Gilles Peskine31b07e22018-03-21 12:15:06 +0100324 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000325 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100326 -iname CMakeFiles -exec rm -rf {} \+ -o \
327 \( -iname cmake_install.cmake -o \
328 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200329 -iname CMakeCache.txt -o \
330 -path './cmake/*.cmake' \) -exec rm -f {} \+
Ronald Cron5cdc22b2024-06-12 10:04:22 +0200331 # Remove Makefiles generated by in-tree CMake builds
332 rm -f 3rdparty/Makefile 3rdparty/*/Makefile pkgconfig/Makefile framework/Makefile
333 rm -f include/Makefile programs/!(fuzz)/Makefile
Ronald Cron30ea2b92024-06-11 14:07:09 +0200334 rm -f tf-psa-crypto/Makefile tf-psa-crypto/include/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200335
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100336 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
337 rm -rf programs/test/cmake_subproject/build
338 rm -f programs/test/cmake_subproject/Makefile
339 rm -f programs/test/cmake_subproject/cmake_subproject
340
Chris Kayd259e342021-03-25 16:03:25 +0000341 # Remove any artifacts from the component_test_cmake_as_package test.
342 rm -rf programs/test/cmake_package/build
343 rm -f programs/test/cmake_package/Makefile
344 rm -f programs/test/cmake_package/cmake_package
345
346 # Remove any artifacts from the component_test_cmake_as_installed_package test.
347 rm -rf programs/test/cmake_package_install/build
348 rm -f programs/test/cmake_package_install/Makefile
349 rm -f programs/test/cmake_package_install/cmake_package_install
350
Gilles Peskinef83eb822020-03-30 20:11:39 +0200351 # Restore files that may have been clobbered by the job
352 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200353 if [[ -e "$x$backup_suffix" ]]; then
354 cp -p "$x$backup_suffix" "$x"
355 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200356 done
357}
John Durkopbd069d32020-10-31 22:14:03 -0700358
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200359# Final cleanup when this script exits (except when exiting on a failure
360# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200361final_cleanup () {
362 cleanup
363
364 for x in $files_to_back_up; do
365 rm -f "$x$backup_suffix"
366 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100367}
368
Gilles Peskine7c652162017-12-11 00:01:40 +0100369# Executed on exit. May be redefined depending on command line options.
370final_report () {
371 :
372}
373
374fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200375 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100376 final_report $1
377 trap - $1
378 kill -$1 $$
379}
380
381trap 'fatal_signal HUP' HUP
382trap 'fatal_signal INT' INT
383trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200384
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200385# Number of processors on this machine. Used as the default setting
386# for parallel make.
387all_sh_nproc ()
388{
389 {
390 nproc || # Linux
391 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
392 sysctl -n hw.ncpu || # FreeBSD
393 echo 1
394 } 2>/dev/null
395}
396
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100397msg()
398{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100399 if [ -n "${current_component:-}" ]; then
400 current_section="${current_component#component_}: $1"
401 else
402 current_section="$1"
403 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200404
405 if [ $QUIET -eq 1 ]; then
406 return
407 fi
408
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100409 echo ""
410 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100411 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000412 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100413 echo "******************************************************************"
414}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100415
Gilles Peskine8f073122018-11-27 15:58:47 +0100416armc6_build_test()
417{
418 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100419
Gilles Peskine18487f62020-04-30 23:11:54 +0200420 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800421 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100422 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000423 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200424
425 msg "size: ARM Compiler 6 ($FLAGS)"
426 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100427}
Andres AGa5cd9732016-10-17 15:23:10 +0100428
Andres AGd9eba4b2016-08-26 14:42:14 +0100429err_msg()
430{
431 echo "$1" >&2
432}
433
434check_tools()
435{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200436 for tool in "$@"; do
437 if ! `type "$tool" >/dev/null 2>&1`; then
438 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100439 exit 1
440 fi
441 done
442}
443
Gilles Peskine8f073122018-11-27 15:58:47 +0100444pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000445 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100446 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100447 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100448 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200449 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000450 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100451
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000452 # Note that legacy options are ignored instead of being omitted from this
453 # list of options, so invocations that worked with previous version of
454 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100455 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100456 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200457 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200458 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200459 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000460 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100461 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
462 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100463 --clang-earliest) shift; CLANG_EARLIEST="$1";;
464 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100465 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000466 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100468 --gcc-earliest) shift; GCC_EARLIEST="$1";;
469 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200471 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
472 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100473 --gnutls-serv) shift; GNUTLS_SERV="$1";;
474 --help|-h) usage; exit;;
475 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000476 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100477 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200479 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000480 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 --no-force) FORCE=0;;
482 --no-keep-going) KEEP_GOING=0;;
483 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200484 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200487 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100488 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200489 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200491 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200492 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 --seed|-s) shift; SEED="$1";;
494 -*)
495 echo >&2 "Unknown option: $1"
496 echo >&2 "Run $0 --help for usage."
497 exit 120
498 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000499 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100500 esac
501 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100502 done
SimonB2e23c822016-04-16 21:54:39 +0100503
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100504 # Exclude components that are not supported on this platform.
505 SUPPORTED_COMPONENTS=
506 for component in $ALL_COMPONENTS; do
507 case $(type "support_$component" 2>&1) in
508 *' function'*)
509 if ! support_$component; then continue; fi;;
510 esac
511 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
512 done
513
514 if [ $list_components -eq 1 ]; then
515 printf '%s\n' $SUPPORTED_COMPONENTS
516 exit
517 fi
518
Gilles Peskinea28db922019-01-10 00:05:18 +0100519 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200520 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000521 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100522 fi
523
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
525 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100526 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000527 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100528 fi
SimonB2e23c822016-04-16 21:54:39 +0100529
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200530 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100531 if [ $all_except -eq 0 ]; then
532 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200533 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
534 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200535 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100536 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200537 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200538 # If the requested name includes a wildcard character, don't
539 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100540 case $component in
541 *[*?\[]*) continue;;
542 esac
543 case " $SUPPORTED_COMPONENTS " in
544 *" $component "*) :;;
545 *)
546 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
547 unsupported=$((unsupported + 1));;
548 esac
549 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200550 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100551 if [ $unsupported -ne 0 ]; then
552 exit 2
553 fi
554 fi
555
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000556 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100557 RUN_COMPONENTS=
558 for component in $SUPPORTED_COMPONENTS; do
559 if is_component_included "$component"; [ $? -eq $all_except ]; then
560 RUN_COMPONENTS="$RUN_COMPONENTS $component"
561 fi
562 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000563
564 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000565 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100566}
SimonB2e23c822016-04-16 21:54:39 +0100567
Gilles Peskine8f073122018-11-27 15:58:47 +0100568pre_check_git () {
569 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100570 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100571 git checkout-index -f -q $CONFIG_H
572 cleanup
573 else
SimonB2e23c822016-04-16 21:54:39 +0100574
Gilles Peskine8f073122018-11-27 15:58:47 +0100575 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
576 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
577 echo "You can either delete this directory manually, or force the test by rerunning"
578 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
579 exit 1
580 fi
581
Ronald Cron7a93ac52023-07-20 09:49:12 +0200582 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100583 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100584 echo "You can either delete or preserve your work, or force the test by rerunning the"
585 echo "script as: $0 --force"
586 exit 1
587 fi
SimonB2e23c822016-04-16 21:54:39 +0100588 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500589}
590
Gilles Peskine568f53a2021-07-12 18:16:01 +0200591pre_restore_files () {
592 # If the makefiles have been generated by a framework such as cmake,
593 # restore them from git. If the makefiles look like modifications from
594 # the ones checked into git, take care not to modify them. Whatever
595 # this function leaves behind is what the script will restore before
596 # each component.
597 case "$(head -n1 Makefile)" in
598 *[Gg]enerated*)
599 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
600 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
601 ;;
602 esac
603}
604
Gilles Peskinef83eb822020-03-30 20:11:39 +0200605pre_back_up () {
606 for x in $files_to_back_up; do
607 cp -p "$x" "$x$backup_suffix"
608 done
609}
610
Gilles Peskine8f073122018-11-27 15:58:47 +0100611pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100612 failure_count=0 # Number of failed components
613 last_failure_status=0 # Last failure status in this component
614
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100615 # See err_trap
616 previous_failure_status=0
617 previous_failed_command=
618 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100619 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100620
Gilles Peskine7c652162017-12-11 00:01:40 +0100621 start_red=
622 end_color=
623 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100624 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100625 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
626 start_red=$(printf '\033[31m')
627 end_color=$(printf '\033[0m')
628 ;;
629 esac
630 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100631
632 # Keep a summary of failures in a file. We'll print it out at the end.
633 failure_summary_file=$PWD/all-sh-failures-$$.log
634 : >"$failure_summary_file"
635
636 # Whether it makes sense to keep a component going after the specified
637 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200638 # This function normally receives the failing simple command
639 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
640 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100641 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200642 # False positives result in running things that can't be expected to
643 # work. False negatives result in things not running after something else
644 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100645 can_keep_going_after_failure () {
646 case "$1" in
647 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200648 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100649 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200650 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
651 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
652 *make*check*) true;;
653 "grep "*) true;;
654 "[ "*) true;;
655 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100656 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100657 esac
658 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100659
660 # This function runs if there is any error in a component.
661 # It must either exit with a nonzero status, or set
662 # last_failure_status to a nonzero value.
663 err_trap () {
664 # Save $? (status of the failing command). This must be the very
665 # first thing, before $? is overridden.
666 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100667 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100668
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100669 if [[ $last_failure_status -eq $previous_failure_status &&
670 "$failed_command" == "$previous_failed_command" &&
671 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
672 then
673 # The same command failed twice in a row, but this time one level
674 # less deep in the function call stack. This happens when the last
675 # command of a function returns a nonzero status, and the function
676 # returns that same status. Ignore the second failure.
677 previous_failure_funcall_depth=${#FUNCNAME[@]}
678 return
679 fi
680 previous_failure_status=$last_failure_status
681 previous_failed_command=$failed_command
682 previous_failure_funcall_depth=${#FUNCNAME[@]}
683
Gilles Peskinece266c42020-03-28 18:50:43 +0100684 text="$current_section: $failed_command -> $last_failure_status"
685 echo "${start_red}^^^^$text^^^^${end_color}" >&2
686 echo "$text" >>"$failure_summary_file"
687
688 # If the command is fatal (configure or build command), stop this
689 # component. Otherwise (test command) keep the component running
690 # (run more tests from the same build).
691 if ! can_keep_going_after_failure "$failed_command"; then
692 exit $last_failure_status
693 fi
694 }
695
Gilles Peskine7c652162017-12-11 00:01:40 +0100696 final_report () {
697 if [ $failure_count -gt 0 ]; then
698 echo
699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100700 echo "${start_red}FAILED: $failure_count components${end_color}"
701 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100702 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
703 elif [ -z "${1-}" ]; then
704 echo "SUCCESS :)"
705 fi
706 if [ -n "${1-}" ]; then
707 echo "Killed by SIG$1."
708 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100709 rm -f "$failure_summary_file"
710 if [ $failure_count -gt 0 ]; then
711 exit 1
712 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100713 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100714}
715
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200716# record_status() and if_build_succeeded() are kept temporarily for backward
717# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100718record_status () {
719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
Gilles Peskine7c652162017-12-11 00:01:40 +0100721if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100722 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100723}
724
Gilles Peskinea681c592020-03-28 21:27:40 +0100725# '! true' does not trigger the ERR trap. Arrange to trigger it, with
726# a reasonably informative error message (not just "$@").
727not () {
728 if "$@"; then
729 report_failed_command="! $*"
730 false
731 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200732 fi
733}
734
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200735pre_prepare_outcome_file () {
736 case "$MBEDTLS_TEST_OUTCOME_FILE" in
737 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
738 esac
739 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
740 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
741 fi
742}
743
Gilles Peskine8f073122018-11-27 15:58:47 +0100744pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200745 if [ $QUIET -eq 1 ]; then
746 return
747 fi
748
Gilles Peskine8f073122018-11-27 15:58:47 +0100749 msg "info: $0 configuration"
750 echo "MEMORY: $MEMORY"
751 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200752 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100754 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100755 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
757 echo "GNUTLS_CLI: $GNUTLS_CLI"
758 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100759 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
760 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
761}
Andres AG7770ea82016-10-10 15:46:20 +0100762
Andres AGd9eba4b2016-08-26 14:42:14 +0100763# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100764pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000765 # Build the list of variables to pass to output_env.sh.
766 set env
SimonB2e23c822016-04-16 21:54:39 +0100767
Gilles Peskine87964262019-01-06 22:40:00 +0000768 case " $RUN_COMPONENTS " in
769 # Require OpenSSL and GnuTLS if running any tests (as opposed to
770 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
771 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100772 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000773 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
774 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100775 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000776 export GNUTLS_CLI="$GNUTLS_CLI"
777 export GNUTLS_SERV="$GNUTLS_SERV"
778 # Avoid passing --seed flag in every call to ssl-opt.sh
779 if [ -n "${SEED-}" ]; then
780 export SEED
781 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200782 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000783 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200784 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
785 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000786 ;;
787 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200788
Gilles Peskine87964262019-01-06 22:40:00 +0000789 case " $RUN_COMPONENTS " in
790 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
791 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100792
Gilles Peskine87964262019-01-06 22:40:00 +0000793 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200794 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000795 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100796
Gilles Peskine87964262019-01-06 22:40:00 +0000797 case " $RUN_COMPONENTS " in
798 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
799 esac
800
801 case " $RUN_COMPONENTS " in
802 *" test_zeroize "*) check_tools "gdb";;
803 esac
804
805 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000806 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
808 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000810 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
811 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200812 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
813 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
814 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000815 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000816
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200817 # past this point, no call to check_tool, only printing output
818 if [ $QUIET -eq 1 ]; then
819 return
820 fi
821
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000822 msg "info: output_env.sh"
823 case $RUN_COMPONENTS in
824 *_armcc*)
825 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
826 *) set "$@" RUN_ARMCC=0;;
827 esac
828 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100829}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100830
Gilles Peskine1570b592021-04-22 01:10:12 +0200831pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200832 # since make doesn't have proper dependencies, remove any possibly outdate
833 # file that might be around before generating fresh ones
834 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200835 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200836 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200837 else
838 make generated_files
839 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200840}
841
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000842clang_version() {
843 if command -v clang > /dev/null ; then
844 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
845 else
846 echo 0 # report version 0 for "no clang"
847 fi
848}
849
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200850################################################################
851#### Helpers for components using libtestdriver1
852################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100853
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200854# How to use libtestdriver1
855# -------------------------
856#
857# 1. Define the list algorithms and key types to accelerate,
858# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
859# Examples:
860# - loc_accel_list="ALG_JPAKE"
861# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200862# 2. Make configurations changes for the driver and/or main libraries.
863# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
864# can be either "default" to start with the default config, or a name
865# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200866# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200867# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
868# These changes affect both the driver and the main libraries.
869# (Note: they need to have the same set of PSA_WANT symbols, as that
870# determines the ABI between them.)
871# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
872# main libraries. Typically, you want to disable the module(s) that are
873# being accelerated. You may need to also disable modules that depend
874# on them or options that are not supported with drivers.
875# 2d. On top of psa/crypto_config.h, the driver library uses its own config
876# file: tests/include/test/drivers/config_test_driver.h. You usually
877# don't need to edit it: using loc_extra_list (see below) is preferred.
878# However, when there's no PSA symbol for what you want to enable,
879# calling scripts/config.py on this file remains the only option.
880# 3. Build the driver library, then the main libraries, test, and programs.
881# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
882# need to enable more algorithms here, typically hash algorithms when
883# accelerating some signature algorithms (ECDSA, RSAv2). This is done
884# by passing a 2nd argument listing the extra algorithms.
885# Example:
886# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
887# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800888# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200889# additional arguments will be passed to make: this can be useful if
890# you don't want to build everything when iterating during development.
891# Example:
892# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
893# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200894
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200895# Adjust the configuration - for both libtestdriver1 and main library,
896# as they should have the same PSA_WANT macros.
897helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200898 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200900 if [ "$base_config" != "default" ]; then
901 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200902 fi
903
904 # Enable PSA-based config (necessary to use drivers)
905 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
906
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200907 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
908 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
909 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000910
911 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
912 # otherwise we will end up running multithreaded tests without mutexes to protect them.
913 if scripts/config.py get MBEDTLS_THREADING_C; then
914 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
915 fi
916
917 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
918 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
919 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200920}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100921
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100922# Build the drivers library libtestdriver1.a (with ASan).
923#
924# Parameters:
925# 1. a space-separated list of things to accelerate;
926# 2. optional: a space-separate list of things to also support.
927# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
928helper_libtestdriver1_make_drivers() {
929 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
930 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
931}
932
933# Build the main libraries, programs and tests,
934# linking to the drivers library (with ASan).
935#
936# Parameters:
937# 1. a space-separated list of things to accelerate;
938# *. remaining arguments if any are passed directly to make
939# (examples: lib, -C tests test_suite_xxx, etc.)
940# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
941helper_libtestdriver1_make_main() {
942 loc_accel_list=$1
943 shift
944
945 # we need flags both with and without the LIBTESTDRIVER1_ prefix
946 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
947 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
948 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" "$@"
949}
950
Valerio Settid1b6ef12024-05-07 16:00:21 +0200951# $1: target which can be "client" or "server"
952helper_crypto_client_build() {
953 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200954 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200955 TARGET_LIB=libpsa$TARGET
956
Valerio Settid1b6ef12024-05-07 16:00:21 +0200957 if [ "$TARGET" == "client" ]; then
958 scripts/config.py full
959 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
960 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
961 # Dynamic secure element support is a deprecated feature and it is not
962 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
963 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
964 # Disable potentially problematic features
965 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
966 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
967 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
968 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
969 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
970 else
971 scripts/config.py crypto_full
972 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
973 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200974 fi
975
Valerio Settif57afd52024-05-14 10:39:20 +0200976 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200977
Valerio Settif57afd52024-05-14 10:39:20 +0200978 # cleanup() will restore some backed-up files which include $CONFIG_H and
979 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
980 # point.
981 cleanup
Valerio Settid1b6ef12024-05-07 16:00:21 +0200982}
983
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100984################################################################
985#### Configuration helpers
986################################################################
987
Valerio Settib2fd6732023-08-15 17:10:47 +0200988# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200989# The function optionally accepts 1 parameter: a space-separated list of the
990# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200991helper_disable_builtin_curves() {
992 allowed_list="${1:-}"
993 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
994
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200995 for curve in $allowed_list; do
996 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200997 done
998}
999
1000# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1001# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1002# in the following helpers.
1003helper_get_psa_curve_list () {
1004 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001005 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1006 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001007 done
1008
1009 echo "$loc_list"
1010}
1011
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001012# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1013# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1014# in the following helpers.
1015helper_get_psa_dh_group_list () {
1016 loc_list=""
1017 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1018 loc_list="$loc_list $item"
1019 done
1020
1021 echo "$loc_list"
1022}
1023
Valerio Settib2fd6732023-08-15 17:10:47 +02001024# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001025# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001026# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001027helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001028 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001029 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001030 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 +02001031 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1032 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001033 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1034 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001035 fi
1036 done
1037
1038 echo "$loc_list"
1039}
1040
Gilles Peskine192c72f2017-12-21 15:59:21 +01001041################################################################
1042#### Basic checks
1043################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001044
1045#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001047#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001048# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001049# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001050# 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 +02001051# time, so start with a GCC build).
1052# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001053#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001054# Indicative running times are given for reference.
1055
Gilles Peskine8f073122018-11-27 15:58:47 +01001056component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001057 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001058 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001059}
Janos Follathb72c6782016-07-19 14:54:17 +01001060
Gilles Peskine67debb62021-05-18 16:09:50 +02001061component_check_generated_files () {
1062 msg "Check: check-generated-files, files generated with make" # 2s
1063 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001064 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001065
1066 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001067 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001068 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001069 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001070
1071 msg "Check: check-generated-files -u, files absent" # 2s
1072 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001073 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001074 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001075 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001076
1077 # This component ends with the generated files present in the source tree.
1078 # This is necessary for subsequent components!
1079}
1080
Gilles Peskine8f073122018-11-27 15:58:47 +01001081component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001082 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001083 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001084}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001085
Gilles Peskine8f073122018-11-27 15:58:47 +01001086component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001087 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001088 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001089}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001090
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001091component_check_changelog () {
1092 msg "Check: changelog entries" # < 1s
1093 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001094 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001095 if [ -e ChangeLog.new ]; then
1096 # Show the diff for information. It isn't an error if the diff is
1097 # non-empty.
1098 diff -u ChangeLog ChangeLog.new || true
1099 rm ChangeLog.new
1100 fi
1101}
1102
Gilles Peskine8f073122018-11-27 15:58:47 +01001103component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001104 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001105 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001106}
Darryl Greena07039c2018-03-13 16:48:16 +00001107
Gilles Peskine895868b2019-09-19 21:30:05 +02001108component_check_test_cases () {
1109 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001110 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001111 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001112 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001113 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001114 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001115 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001116 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001117}
1118
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001119component_check_test_dependencies () {
1120 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001121 # The purpose of this component is to catch unjustified dependencies on
1122 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1123 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1124 # MBEDTLS_PSA_xxx).
1125 #
1126 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1127 # this component is meant to catch. However a few of them are justified,
1128 # mostly by the absence of a PSA equivalent, so this component includes a
1129 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001130
1131 found="check-test-deps-found-$$"
1132 expected="check-test-deps-expected-$$"
1133
1134 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001135 grep 'depends_on' \
1136 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001137 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001138 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001139 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001140
Yanray Wang18040ed2023-11-23 21:29:56 +08001141 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001142 rm -f $expected
1143 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1144 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001145 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1146 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001147 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1148 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001149 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1150 # the test code and that's probably the most convenient way of achieving
1151 # the test's goal.
1152 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1153 # No PSA equivalent - we should probably have one in the future.
1154 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1155 # No PSA equivalent - needed by some init tests
1156 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001157 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001158 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001159
1160 # Compare reality with expectation.
1161 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001162 #
1163 # The output should be empty. When it's not:
1164 # - Each '+' line is a macro that was found but not expected. You want to
1165 # find where that macro occurs, and either replace it with PSA macros, or
1166 # add it to the exceptions list above with a justification.
1167 # - Each '-' line is a macro that was expected but not found; it means the
1168 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001169 diff -U0 $expected $found
1170
1171 rm $found $expected
1172}
1173
Gilles Peskine8f073122018-11-27 15:58:47 +01001174component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001175 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001176 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001177}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001178
Gilles Peskine192c72f2017-12-21 15:59:21 +01001179
Gilles Peskine636c26a2020-03-04 20:46:15 +01001180
Gilles Peskine192c72f2017-12-21 15:59:21 +01001181################################################################
1182#### Build and test many configurations and targets
1183################################################################
1184
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001185component_test_default_out_of_box () {
1186 msg "build: make, default config (out-of-box)" # ~1min
1187 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001188 # Disable fancy stuff
1189 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001190
1191 msg "test: main suites make, default config (out-of-box)" # ~10s
1192 make test
1193
1194 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001195 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001196
1197 msg "program demos: make, default config (out-of-box)" # ~10s
1198 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001199}
1200
Gilles Peskine8f073122018-11-27 15:58:47 +01001201component_test_default_cmake_gcc_asan () {
1202 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001203 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1204 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001205
Gilles Peskine8f073122018-11-27 15:58:47 +01001206 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1207 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001208
Gilles Peskine82b27272019-06-14 18:27:03 +02001209 msg "program demos (ASan build)" # ~10s
1210 tests/scripts/run_demos.py
1211
Gilles Peskine97bea012020-04-23 23:37:45 +02001212 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001213 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001214
Gilles Peskine6848d172023-11-02 19:58:03 +01001215 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001216 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001217
Gilles Peskine8f073122018-11-27 15:58:47 +01001218 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001219 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001220
Gilles Peskine8f073122018-11-27 15:58:47 +01001221 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001222 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001223
1224 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001225 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001226}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001227
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001228component_test_default_cmake_gcc_asan_new_bignum () {
1229 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001230 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001231 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001232 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001233
1234 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1235 make test
1236
1237 msg "test: selftest (ASan build)" # ~ 10s
1238 programs/test/selftest
1239
1240 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1241 tests/ssl-opt.sh
1242
1243 msg "test: compat.sh (ASan build)" # ~ 6 min
1244 tests/compat.sh
1245
1246 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1247 tests/context-info.sh
1248}
1249
Hanno Becker01635512019-02-26 14:27:09 +00001250component_test_full_cmake_gcc_asan () {
1251 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001252 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001253 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1254 make
1255
1256 msg "test: main suites (inc. selftests) (full config, ASan build)"
1257 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001258
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001259 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001260 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001261
Gilles Peskine636c26a2020-03-04 20:46:15 +01001262 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001263 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001264
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001265 # Note: the next two invocations cover all compat.sh test cases.
1266 # We should use the same here and in basic-build-test.sh.
1267 msg "test: compat.sh: default version (full config, ASan build)"
1268 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001269
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001270 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1271 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001272
1273 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001274 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001275}
1276
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001277
1278component_test_full_cmake_gcc_asan_new_bignum () {
1279 msg "build: full config, cmake, gcc, ASan"
1280 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001281 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001282 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001283 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001284
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001285 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001286 make test
1287
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001288 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001289 programs/test/selftest
1290
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001291 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001292 tests/ssl-opt.sh
1293
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001294 # Note: the next two invocations cover all compat.sh test cases.
1295 # We should use the same here and in basic-build-test.sh.
1296 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1297 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001298
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001299 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1300 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001301
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001302 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001303 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001304}
1305
Ronald Cronc3623db2020-10-29 10:51:32 +01001306component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001307 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001308 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001309 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1310 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1311 make
1312
1313 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1314 make test
1315}
1316
David Horstmann4a48bec2024-03-13 15:42:31 +00001317component_test_psa_assume_exclusive_buffers () {
1318 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001319 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001320 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001321 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1322 make
1323
David Horstmann4a48bec2024-03-13 15:42:31 +00001324 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001325 make test
1326}
1327
Gilles Peskinea3548672021-06-17 11:37:52 +02001328# check_renamed_symbols HEADER LIB
1329# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1330# name is LIB.
1331check_renamed_symbols () {
1332 ! nm "$2" | sed 's/.* //' |
1333 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1334}
1335
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001336component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001337 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001338 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001339 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1340 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1341 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1342 # We can only compile, not link, since our test and sample programs
1343 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1344 # is active.
1345 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001346
1347 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1348 # version is not present.
1349 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001350 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001351}
1352
Valerio Setti63097752024-03-12 13:18:13 +01001353# Get a list of library-wise undefined symbols and ensure that they only
1354# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1355# This function is a common helper used by both:
1356# - component_test_default_psa_crypto_client_without_crypto_provider
1357# - component_build_full_psa_crypto_client_without_crypto_provider.
1358common_check_mbedtls_missing_symbols() {
1359 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1360 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1361 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1362 not grep mbedtls_ linking_errors.txt
1363
1364 rm sym_def.txt sym_undef.txt linking_errors.txt
1365}
1366
1367component_test_default_psa_crypto_client_without_crypto_provider () {
1368 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1369
Ronald Cron336678b2021-01-28 17:54:24 +01001370 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1371 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001372 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001373 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001374 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001375 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001376
Ronald Cron336678b2021-01-28 17:54:24 +01001377 make
1378
Valerio Setti63097752024-03-12 13:18:13 +01001379 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1380 common_check_mbedtls_missing_symbols
1381
1382 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001383 make test
1384}
1385
Valerio Setti63097752024-03-12 13:18:13 +01001386component_build_full_psa_crypto_client_without_crypto_provider () {
1387 msg "build: full config - PSA_CRYPTO_C"
1388
1389 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1390 scripts/config.py full
1391
1392 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1393 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1394 # Dynamic secure element support is a deprecated feature and it is not
1395 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1396 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1397
1398 # Since there is no crypto provider in this build it is not possible to
1399 # build all the test executables and progrems due to missing PSA functions
1400 # at link time. Therefore we will just build libraries and we'll check
1401 # that symbols of interest are there.
1402 make lib
1403
1404 msg "check missing symbols: full config - PSA_CRYPTO_C"
1405
1406 common_check_mbedtls_missing_symbols
1407
1408 # Ensure that desired functions are included into the build (extend the
1409 # following list as required).
1410 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1411 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1412 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1413}
1414
Ryan Everettdaa322a2024-04-18 16:48:55 +01001415component_test_no_rsa_key_pair_generation() {
1416 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001417 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001418 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001419 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001420 make
1421
Ryan Everettdaa322a2024-04-18 16:48:55 +01001422 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001423 make test
1424}
1425
Gilles Peskine782f4112018-11-27 16:11:09 +01001426component_test_ref_configs () {
1427 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001428 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1429 # want to re-generate generated files that depend on it, quite correctly.
1430 # However this doesn't work as the generation script expects a specific
1431 # format for mbedtls_config.h, which the other files don't follow. Also,
1432 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001433 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001434 # whether they're on or off. So, disable cmake's (over-sensitive here)
1435 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001436 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001437 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001438 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001439}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001440
Gilles Peskine8f073122018-11-27 15:58:47 +01001441component_test_no_renegotiation () {
1442 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001443 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001444 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001445 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001446
Gilles Peskine8f073122018-11-27 15:58:47 +01001447 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1448 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001449
Gilles Peskine8f073122018-11-27 15:58:47 +01001450 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001451 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001452}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001453
Gilles Peskine636c26a2020-03-04 20:46:15 +01001454component_test_no_pem_no_fs () {
1455 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1456 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1457 scripts/config.py unset MBEDTLS_FS_IO
1458 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1459 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001460 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001461 make
1462
1463 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1464 make test
1465
1466 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001467 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001468}
1469
Gilles Peskine8f073122018-11-27 15:58:47 +01001470component_test_rsa_no_crt () {
1471 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001472 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001473 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001474 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1477 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001478
Gilles Peskine8f073122018-11-27 15:58:47 +01001479 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001480 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001481
Gilles Peskine8f073122018-11-27 15:58:47 +01001482 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001483 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001484
1485 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001486 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001487}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001488
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001489component_test_no_ctr_drbg_classic () {
1490 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001491 scripts/config.py full
1492 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001493 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001494 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001495
Dave Rodgman17127e92023-12-14 16:42:48 +00001496 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497 make
1498
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001499 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001500 make test
1501
Gilles Peskineba749042021-01-13 20:02:03 +01001502 # In this configuration, the TLS test programs use HMAC_DRBG.
1503 # The SSL tests are slow, so run a small subset, just enough to get
1504 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001505 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001506 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001507
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001508 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001509 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001510}
1511
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512component_test_no_ctr_drbg_use_psa () {
1513 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001514 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001515 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1516 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001517
Dave Rodgman17127e92023-12-14 16:42:48 +00001518 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001519 make
1520
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001521 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1522 make test
1523
1524 # In this configuration, the TLS test programs use HMAC_DRBG.
1525 # The SSL tests are slow, so run a small subset, just enough to get
1526 # confidence that the SSL code copes with HMAC_DRBG.
1527 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001528 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001529
1530 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001531 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001532}
1533
1534component_test_no_hmac_drbg_classic () {
1535 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1536 scripts/config.py full
1537 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1538 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1539 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001540 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001541
Dave Rodgman17127e92023-12-14 16:42:48 +00001542 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001543 make
1544
1545 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001546 make test
1547
Gilles Peskinea2224342020-11-19 22:14:34 +01001548 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1549 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1550 # instead.
1551 # Test SSL with non-deterministic ECDSA. Only test features that
1552 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001553 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001554 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001555
1556 # To save time, only test one protocol version, since this part of
1557 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001558 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001559 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001560}
1561
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001562component_test_no_hmac_drbg_use_psa () {
1563 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1564 scripts/config.py full
1565 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1566 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1567 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1568
Dave Rodgman17127e92023-12-14 16:42:48 +00001569 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001570 make
1571
1572 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1573 make test
1574
1575 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1576 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1577 # instead.
1578 # Test SSL with non-deterministic ECDSA. Only test features that
1579 # might be affected by how ECDSA signature is performed.
1580 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001581 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001582
1583 # To save time, only test one protocol version, since this part of
1584 # the protocol is identical in (D)TLS up to 1.2.
1585 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001586 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001587}
1588
1589component_test_psa_external_rng_no_drbg_classic () {
1590 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1591 scripts/config.py full
1592 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001593 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001594 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001595 scripts/config.py unset MBEDTLS_ENTROPY_C
1596 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1597 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001598 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1599 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1600 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001601 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1602 # the SSL test programs don't have an RNG and can't work. Explicitly
1603 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001604 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001605
1606 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1607 make test
1608
Gilles Peskine8eb29432021-02-03 20:07:11 +01001609 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001610 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001611}
1612
1613component_test_psa_external_rng_no_drbg_use_psa () {
1614 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001615 scripts/config.py full
1616 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001617 scripts/config.py unset MBEDTLS_ENTROPY_C
1618 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1619 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001620 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1621 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1622 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001623 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001624
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001625 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001626 make test
1627
Gilles Peskine8eb29432021-02-03 20:07:11 +01001628 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001629 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001630}
1631
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001632component_test_psa_external_rng_use_psa_crypto () {
1633 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1634 scripts/config.py full
1635 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1636 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1637 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001638 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001639
1640 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1641 make test
1642
1643 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1644 tests/ssl-opt.sh -f 'Default\|opaque'
1645}
1646
Gilles Peskine801c4332023-04-28 21:04:28 +02001647component_test_psa_inject_entropy () {
1648 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1649 scripts/config.py full
1650 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1651 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1652 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1653 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1654 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1655 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001656 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine801c4332023-04-28 21:04:28 +02001657
1658 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1659 make test
1660}
1661
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001662component_test_sw_inet_pton () {
1663 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1664
1665 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1666 scripts/config.py set MBEDTLS_TEST_HOOKS
1667 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1668
1669 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1670 make test
1671}
1672
Valerio Settia41654d2024-02-08 10:33:11 +01001673component_full_no_pkparse_pkwrite() {
1674 msg "build: full without pkparse and pkwrite"
1675
1676 scripts/config.py crypto_full
1677 scripts/config.py unset MBEDTLS_PK_PARSE_C
1678 scripts/config.py unset MBEDTLS_PK_WRITE_C
1679
Valerio Settia41654d2024-02-08 10:33:11 +01001680 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1681
1682 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1683 not grep mbedtls_pk_parse_key library/pkparse.o
1684 not grep mbedtls_pk_write_key_der library/pkwrite.o
1685
1686 msg "test: full without pkparse and pkwrite"
1687 make test
1688}
1689
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001690component_test_crypto_full_md_light_only () {
1691 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001692 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001693 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001694 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001695 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001696 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001697 scripts/config.py unset MBEDTLS_HKDF_C
1698 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001699 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001700 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001701 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001702 # Disable things that would auto-enable MD_C
1703 scripts/config.py unset MBEDTLS_PKCS5_C
1704
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001705 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1706 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001707 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001708
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001709 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001710 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001711 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001712
1713 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001714 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001715}
1716
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001717component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001718 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001719 scripts/config.py full
1720 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001721 # Don't pull in cipher via PSA mechanisms
1722 # (currently ignored anyway because we completely disable PSA)
1723 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001724 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001725 scripts/config.py unset MBEDTLS_CMAC_C
1726 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001727 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001728 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001729 scripts/config.py unset MBEDTLS_SSL_TLS_C
1730 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001731 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001732 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1733 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001734 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001735 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001736 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001737
Valerio Settidf17a102023-10-23 14:14:19 +02001738 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001739 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001740}
1741
Valerio Setti7e710e82023-08-25 09:14:15 +02001742# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001743# - component_test_full_no_cipher_with_psa_crypto
1744# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001745# It accepts 2 input parameters:
1746# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1747# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001748common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001749 USE_CRYPTO_CONFIG="$1"
1750 COMPONENT_DESCRIPTION="$2"
1751
1752 msg "build: $COMPONENT_DESCRIPTION"
1753
1754 scripts/config.py full
1755 scripts/config.py unset MBEDTLS_CIPHER_C
1756
1757 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001758 # The built-in implementation of the following algs/key-types depends
1759 # on CIPHER_C so we disable them.
1760 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1761 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001762 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001763 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1764 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1765 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1766 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1767 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1768 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1769 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Crona33a8242024-05-15 18:31:17 +02001770 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001771 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001772 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001773 else
1774 # Don't pull in cipher via PSA mechanisms
1775 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001776 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1777 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1778 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001779 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001780 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001781 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001782 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001783
Gilles Peskine21570cf2023-12-22 11:49:50 +01001784 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001785
Valerio Setti7e710e82023-08-25 09:14:15 +02001786 # Ensure that CIPHER_C was not re-enabled
1787 not grep mbedtls_cipher_init library/cipher.o
1788
1789 msg "test: $COMPONENT_DESCRIPTION"
1790 make test
1791}
1792
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001793component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001794 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001795}
1796
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001797component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001798 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001799}
1800
Valerio Settibdfecb62023-11-07 15:37:20 +01001801component_test_full_no_ccm() {
1802 msg "build: full no PSA_WANT_ALG_CCM"
1803
1804 # Full config enables:
1805 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1806 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1807 scripts/config.py full
1808
1809 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1810 # enabled, but not used from TLS since USE_PSA is set.
1811 # This is helpful to ensure that TLS tests below have proper dependencies.
1812 #
1813 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1814 # PSA_WANT_ALG_CCM to be re-enabled.
1815 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1816
Gilles Peskine21570cf2023-12-22 11:49:50 +01001817 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001818
1819 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001820 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001821}
1822
1823component_test_full_no_ccm_star_no_tag() {
1824 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1825
1826 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1827 scripts/config.py full
1828
1829 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1830 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1831 # This basically disables all unauthenticated ciphers on the PSA side, while
1832 # keeping AEADs enabled.
1833 #
1834 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1835 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1836 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1840 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1841 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1842 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1843 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1844
Gilles Peskine21570cf2023-12-22 11:49:50 +01001845 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001846
1847 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001848 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001849
1850 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001851 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001852}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001853
Valerio Settie1655b82023-01-03 15:35:25 +01001854component_test_full_no_bignum () {
1855 msg "build: full minus bignum"
1856 scripts/config.py full
1857 scripts/config.py unset MBEDTLS_BIGNUM_C
1858 # Direct dependencies of bignum
1859 scripts/config.py unset MBEDTLS_ECP_C
1860 scripts/config.py unset MBEDTLS_RSA_C
1861 scripts/config.py unset MBEDTLS_DHM_C
1862 # Direct dependencies of ECP
1863 scripts/config.py unset MBEDTLS_ECDH_C
1864 scripts/config.py unset MBEDTLS_ECDSA_C
1865 scripts/config.py unset MBEDTLS_ECJPAKE_C
1866 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001867 # Disable what auto-enables ECP_LIGHT
1868 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1869 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001870 # Indirect dependencies of ECP
1871 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1872 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1873 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1874 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1875 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1876 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1877 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1878 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1879 # Direct dependencies of DHM
1880 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1881 # Direct dependencies of RSA
1882 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1883 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1884 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1885 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1886 # PK and its dependencies
1887 scripts/config.py unset MBEDTLS_PK_C
1888 scripts/config.py unset MBEDTLS_PK_PARSE_C
1889 scripts/config.py unset MBEDTLS_PK_WRITE_C
1890 scripts/config.py unset MBEDTLS_X509_USE_C
1891 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1892 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1893 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1894 scripts/config.py unset MBEDTLS_X509_CREATE_C
1895 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1896 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1897 scripts/config.py unset MBEDTLS_PKCS7_C
1898 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1899 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1900 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1901
Gilles Peskine21570cf2023-12-22 11:49:50 +01001902 make
Valerio Settie1655b82023-01-03 15:35:25 +01001903
1904 msg "test: full minus bignum"
1905 make test
1906}
1907
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001908component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001909 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001910
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001911 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001912 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001913 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001914 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001915 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001916 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1917 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001918 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001919 scripts/config.py unset MBEDTLS_GCM_C
1920 scripts/config.py unset MBEDTLS_CCM_C
1921 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001922 #Disable TLS 1.3 (as no AEAD)
1923 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001924 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1925 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1926 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001927 # 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 +01001928 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001929 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001930 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001931 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001932 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1933 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001934 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001935 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001936 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001937
Przemek Stekiel9550c052022-09-28 09:51:55 +02001938 make
1939
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001940 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001941 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001942
1943 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001944}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001945
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001946component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001947 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001948
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001949 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001950 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001951 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001952 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001953 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001954 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1955 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001956 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001957 scripts/config.py unset MBEDTLS_GCM_C
1958 scripts/config.py unset MBEDTLS_CCM_C
1959 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001960 #Disable TLS 1.3 (as no AEAD)
1961 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001962 # 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 +01001963 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001964 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001965 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001966 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001967 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001968 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001969 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001970 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001971
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001972 make
1973
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001974 msg "test: default with only CBC-legacy cipher use psa"
1975 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001976
1977 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1978 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001979}
1980
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001981component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001982 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001983
1984 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001985 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001986 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001987 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001988 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001989 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1990 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001991 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001992 scripts/config.py unset MBEDTLS_GCM_C
1993 scripts/config.py unset MBEDTLS_CCM_C
1994 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001995 #Disable TLS 1.3 (as no AEAD)
1996 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001997 # 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 +01001998 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001999 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2000 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2001 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002002 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002003 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002004 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002005 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002006
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002007 make
2008
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002009 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002010 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002011
2012 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2013 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002014}
2015
Valerio Setti9f0ec532022-11-08 13:03:24 +01002016# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2017# that we could use for interop testing. However, we now have sort of two
2018# implementations ourselves: one using PSA, the other not. At least test that
2019# these two interoperate with each other.
2020component_test_tls1_2_ecjpake_compatibility() {
2021 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2022 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002023 # Explicitly make lib first to avoid a race condition:
2024 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2025 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002026 make -C programs ssl/ssl_server2 ssl/ssl_client2
2027 cp programs/ssl/ssl_server2 s2_no_use_psa
2028 cp programs/ssl/ssl_client2 c2_no_use_psa
2029
2030 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2031 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2032 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002033 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002034 make -C programs ssl/ssl_server2 ssl/ssl_client2
2035 make -C programs test/udp_proxy test/query_compile_time_config
2036
Valerio Setti70e02902022-12-02 16:21:56 +01002037 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2038 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2039 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2040 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2041 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2042 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2043 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2044 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 +01002045
2046 rm s2_no_use_psa c2_no_use_psa
2047}
2048
Gilles Peskine636c26a2020-03-04 20:46:15 +01002049component_test_everest () {
2050 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2051 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2052 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2053 make
2054
2055 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2056 make test
2057
Gilles Peskine6848d172023-11-02 19:58:03 +01002058 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002059 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002060
Gilles Peskine636c26a2020-03-04 20:46:15 +01002061 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2062 tests/ssl-opt.sh -f ECDH
2063
2064 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2065 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002066 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002067}
2068
Gilles Peskined3beca92020-07-03 00:15:37 +02002069component_test_everest_curve25519_only () {
2070 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002071 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02002072 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2073 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002074 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
2075 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
2076 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02002077 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2078 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002079 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002080 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
2081
Gilles Peskined3beca92020-07-03 00:15:37 +02002082 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002083 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002084 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
2085 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02002086
Dave Rodgman17127e92023-12-14 16:42:48 +00002087 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002088
2089 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2090 make test
2091}
2092
Gilles Peskine8f073122018-11-27 15:58:47 +01002093component_test_small_ssl_out_content_len () {
2094 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002095 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2096 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002097 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002098 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002099
Gilles Peskine8f073122018-11-27 15:58:47 +01002100 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002101 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002102}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002103
Gilles Peskine8f073122018-11-27 15:58:47 +01002104component_test_small_ssl_in_content_len () {
2105 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002106 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2107 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002108 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002109 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002110
Gilles Peskine8f073122018-11-27 15:58:47 +01002111 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002112 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002113}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002114
Gilles Peskine8f073122018-11-27 15:58:47 +01002115component_test_small_ssl_dtls_max_buffering () {
2116 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002117 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002118 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002119 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002120
Gilles Peskine8f073122018-11-27 15:58:47 +01002121 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002122 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 +01002123}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002124
Gilles Peskine8f073122018-11-27 15:58:47 +01002125component_test_small_mbedtls_ssl_dtls_max_buffering () {
2126 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002127 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002128 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002129 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002130
Gilles Peskine8f073122018-11-27 15:58:47 +01002131 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002132 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002133}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002134
Gilles Peskine75cc7712019-09-06 19:47:17 +02002135component_test_psa_collect_statuses () {
2136 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002137 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002138 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002139 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002140 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002141 rm -f tests/statuses.log
2142}
2143
Gilles Peskine8f073122018-11-27 15:58:47 +01002144component_test_full_cmake_clang () {
2145 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002146 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002147 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 +01002148 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002149
k-stachowiak0291cb72019-06-26 15:52:12 +02002150 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002151 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002152
Gilles Peskineda6017c2022-10-30 21:02:40 +01002153 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2154 programs/test/cpp_dummy_build
2155
Gilles Peskine6848d172023-11-02 19:58:03 +01002156 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002157 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002158
Gilles Peskine82b27272019-06-14 18:27:03 +02002159 msg "program demos (full config, clang)" # ~10s
2160 tests/scripts/run_demos.py
2161
k-stachowiak0291cb72019-06-26 15:52:12 +02002162 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002163 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002164
Gilles Peskine8f073122018-11-27 15:58:47 +01002165 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002166 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002167}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002168
Gilles Peskine0c671602022-11-29 16:01:41 +01002169skip_suites_without_constant_flow () {
2170 # Skip the test suites that don't have any constant-flow annotations.
2171 # This will need to be adjusted if we ever start declaring things as
2172 # secret from macros or functions inside tests/include or tests/src.
2173 SKIP_TEST_SUITES=$(
2174 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2175 sed 's/test_suite_//; s/\.function$//' |
2176 tr '\n' ,)
2177 export SKIP_TEST_SUITES
2178}
2179
Dave Rodgman246210e2023-07-31 18:07:44 +01002180skip_all_except_given_suite () {
2181 # Skip all but the given test suite
2182 SKIP_TEST_SUITES=$(
2183 ls -1 tests/suites/test_suite_*.function |
2184 grep -v $1.function |
2185 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2186 tr '\n' ,)
2187 export SKIP_TEST_SUITES
2188}
2189
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002190component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002191 # This tests both (1) accesses to undefined memory, and (2) branches or
2192 # memory access depending on secret values. To distinguish between those:
2193 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2194 # - or alternatively, change the build type to MemSanDbg, which enables
2195 # origin tracking and nicer stack traces (which are useful for debugging
2196 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002197 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2198 scripts/config.py full
2199 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2200 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2201 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2202 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2203 make
2204
2205 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2206 make test
2207}
2208
2209component_test_memsan_constant_flow_psa () {
2210 # This tests both (1) accesses to undefined memory, and (2) branches or
2211 # memory access depending on secret values. To distinguish between those:
2212 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2213 # - or alternatively, change the build type to MemSanDbg, which enables
2214 # origin tracking and nicer stack traces (which are useful for debugging
2215 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002216 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002217 scripts/config.py full
2218 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2219 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2220 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2221 make
2222
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002223 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002224 make test
2225}
2226
Bence Szépkúti0354d042023-12-06 16:14:37 +01002227component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002228 # This tests both (1) everything that valgrind's memcheck usually checks
2229 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2230 # etc.) and (2) branches or memory access depending on secret values,
2231 # which will be reported as uninitialized memory. To distinguish between
2232 # secret and actually uninitialized:
2233 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2234 # - or alternatively, build with debug info and manually run the offending
2235 # test suite with valgrind --track-origins=yes, then check if the origin
2236 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002237 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2238 scripts/config.py full
2239 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2240 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002241 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002242 cmake -D CMAKE_BUILD_TYPE:String=Release .
2243 make
2244
2245 # this only shows a summary of the results (how many of each type)
2246 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002247 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002248 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002249
2250 # Test asm path in constant time module - by default, it will test the plain C
2251 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2252 msg "test: valgrind asm constant_time"
2253 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2254 skip_all_except_given_suite test_suite_constant_time
2255 cmake -D CMAKE_BUILD_TYPE:String=Release .
2256 make clean
2257 make
2258 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002259}
2260
Bence Szépkúti0354d042023-12-06 16:14:37 +01002261component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002262 # This tests both (1) everything that valgrind's memcheck usually checks
2263 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2264 # etc.) and (2) branches or memory access depending on secret values,
2265 # which will be reported as uninitialized memory. To distinguish between
2266 # secret and actually uninitialized:
2267 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2268 # - or alternatively, build with debug info and manually run the offending
2269 # test suite with valgrind --track-origins=yes, then check if the origin
2270 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002271 msg "build: cmake release GCC, full config with constant flow testing"
2272 scripts/config.py full
2273 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002274 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002275 cmake -D CMAKE_BUILD_TYPE:String=Release .
2276 make
2277
2278 # this only shows a summary of the results (how many of each type)
2279 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002280 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002281 make memcheck
2282}
2283
Janos Follath9338cac2023-10-04 18:55:39 +01002284component_test_tsan () {
2285 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002286 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002287 scripts/config.py set MBEDTLS_THREADING_C
2288 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002289 # Self-tests do not currently use multiple threads.
2290 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002291
Ryan6caf84f2024-03-05 13:57:00 +00002292 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2293 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2294
Janos Follath9338cac2023-10-04 18:55:39 +01002295 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2296 make
2297
2298 msg "test: main suites (TSan)"
2299 make test
2300}
2301
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002302component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002303 # Test that removing the deprecated features from the default
2304 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002305 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2306 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002307 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002308
2309 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2310 make test
2311}
2312
2313component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002314 msg "build: make, full_no_deprecated config" # ~ 30s
2315 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002316 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002317
Gilles Peskine30de2e82020-04-20 21:39:22 +02002318 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002319 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002320
2321 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2322 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002323}
2324
Gilles Peskine8386ea22020-04-30 09:07:29 +02002325component_test_full_no_deprecated_deprecated_warning () {
2326 # Test that there is nothing deprecated in "full_no_deprecated".
2327 # A deprecated feature would trigger a warning (made fatal) from
2328 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002329 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2330 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002331 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2332 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002333 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002334
Gilles Peskine30de2e82020-04-20 21:39:22 +02002335 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002336 make test
2337}
2338
Gilles Peskine8386ea22020-04-30 09:07:29 +02002339component_test_full_deprecated_warning () {
2340 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2341 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002342 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002343 scripts/config.py full
2344 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002345 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002346 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2347 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002348 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002349
Gilles Peskine8386ea22020-04-30 09:07:29 +02002350 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2351 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2352 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002353 # Expect warnings from '#warning' directives in check_config.h and
2354 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002355 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 +01002356
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002357 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2358 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002359
2360 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2361 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002362}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002363
Gilles Peskineec541fe2020-01-31 14:24:14 +01002364# Check that the specified libraries exist and are empty.
2365are_empty_libraries () {
2366 nm "$@" >/dev/null 2>/dev/null
2367 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2368}
2369
2370component_build_crypto_default () {
2371 msg "build: make, crypto only"
2372 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002373 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002374 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002375}
2376
2377component_build_crypto_full () {
2378 msg "build: make, crypto only, full config"
2379 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002380 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002381 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002382}
2383
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002384component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002385 msg "build: make, config for PSA crypto service"
2386 scripts/config.py crypto
2387 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2388 # Disable things that are not needed for just cryptography, to
2389 # reach a configuration that would be typical for a PSA cryptography
2390 # service providing all implemented PSA algorithms.
2391 # System stuff
2392 scripts/config.py unset MBEDTLS_ERROR_C
2393 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002394 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002395 # Crypto stuff with no PSA interface
2396 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002397 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002398 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002399 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002400 scripts/config.py unset MBEDTLS_NIST_KW_C
2401 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2402 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2403 scripts/config.py unset MBEDTLS_PKCS12_C
2404 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002405 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2406 # in PSA code to work with RSA keys. We don't require users to set those:
2407 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002408 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002409 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002410 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002411 make CFLAGS='-O1 -Werror' all test
2412 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2413}
2414
Gilles Peskineec541fe2020-01-31 14:24:14 +01002415component_build_crypto_baremetal () {
2416 msg "build: make, crypto only, baremetal config"
2417 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002418 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002419 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002420}
Daniel Axtens446af202020-09-02 21:30:13 +10002421support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002422 support_build_baremetal "$@"
2423}
2424
2425component_build_baremetal () {
2426 msg "build: make, baremetal config"
2427 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002428 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002429}
2430support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002431 # Older Glibc versions include time.h from other headers such as stdlib.h,
2432 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2433 # problem, Ubuntu 18.04 is ok.
2434 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2435}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002436
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002437# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002438component_test_depends_py_cipher_id () {
2439 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002440 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002441}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002442
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002443component_test_depends_py_cipher_chaining () {
2444 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002445 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002446}
2447
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002448component_test_depends_py_cipher_padding () {
2449 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002450 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002451}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002452
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002453component_test_depends_py_curves () {
2454 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002455 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002456}
2457
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002458component_test_depends_py_hashes () {
2459 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002460 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002461}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002462
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002463component_test_depends_py_kex () {
2464 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002465 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002466}
2467
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002468component_test_depends_py_pkalgs () {
2469 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002470 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002471}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002472
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002473# PSA equivalents of the depends.py tests
2474component_test_depends_py_cipher_id_psa () {
2475 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002476 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002477}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002478
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002479component_test_depends_py_cipher_chaining_psa () {
2480 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002481 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002482}
2483
2484component_test_depends_py_cipher_padding_psa () {
2485 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002486 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002487}
2488
2489component_test_depends_py_curves_psa () {
2490 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002491 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002492}
2493
2494component_test_depends_py_hashes_psa () {
2495 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002496 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002497}
2498
2499component_test_depends_py_kex_psa () {
2500 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002501 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002502}
2503
2504component_test_depends_py_pkalgs_psa () {
2505 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002506 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002507}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002508
Valerio Setti6bed64e2024-01-17 15:21:44 +01002509component_test_psa_crypto_config_ffdh_2048_only () {
2510 msg "build: full config - only DH 2048"
2511
2512 scripts/config.py full
2513
2514 # Disable all DH groups other than 2048.
2515 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2516 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2517 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2518 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2519
2520 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2521
2522 msg "test: full config - only DH 2048"
2523 make test
2524
2525 msg "ssl-opt: full config - only DH 2048"
2526 tests/ssl-opt.sh -f "ffdh"
2527}
2528
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002529component_build_no_pk_rsa_alt_support () {
2530 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2531
2532 scripts/config.py full
2533 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2534 scripts/config.py set MBEDTLS_RSA_C
2535 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2536
2537 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002538 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002539}
2540
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002541component_build_module_alt () {
2542 msg "build: MBEDTLS_XXX_ALT" # ~30s
2543 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002544
2545 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002546 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2547 scripts/config.py unset MBEDTLS_AESNI_C
2548 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002549 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002550 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2551 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002552 # You can only have one threading implementation: alt or pthread, not both.
2553 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002554 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2555 # directly and assumes the implementation works with partial groups.
2556 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002557 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2558 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2559 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002560 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2561 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2562 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002563
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002564 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2565 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2566 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002567 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002568
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002569 # We can only compile, not link, since we don't have any implementations
2570 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002571 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002572}
2573
2574component_build_dhm_alt () {
2575 msg "build: MBEDTLS_DHM_ALT" # ~30s
2576 scripts/config.py full
2577 scripts/config.py set MBEDTLS_DHM_ALT
2578 # debug.c currently references mbedtls_dhm_context fields directly.
2579 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002580 # We can only compile, not link, since we don't have any implementations
2581 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002582 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002583}
2584
Gilles Peskine64996c32024-01-23 20:25:47 +01002585component_test_no_psa_crypto_full_cmake_asan() {
2586 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2587 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002588 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002589 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002590 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002591 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002592 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002593 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002594 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002595 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002596 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002597 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002598 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002599 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002600
Gilles Peskine64996c32024-01-23 20:25:47 +01002601 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002602 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002603
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002604 # Note: ssl-opt.sh has some test cases that depend on
2605 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2606 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002607 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002608 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002609
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002610 # Note: the next two invocations cover all compat.sh test cases.
2611 # We should use the same here and in basic-build-test.sh.
2612 msg "test: compat.sh: default version (full minus PSA crypto)"
2613 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002614
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002615 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002616 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002617}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002618
Ronald Cron403c15c2021-09-13 09:38:05 +02002619component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002620 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002621
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002622 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002623 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002624 $(helper_get_psa_key_type_list "ECC") \
2625 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002626
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002627 # Configure
2628 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002629
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002630 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002631 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002632
2633 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002634 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002635
2636 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002637 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2638 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2639
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002640 # Build
2641 # -----
2642
2643 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002644 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2645 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002646
2647 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2648
Valerio Setti3fe105b2023-10-30 11:08:12 +01002649 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002650
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002651 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002652 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002653
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002654 # Run the tests
2655 # -------------
2656
Ronald Cron403c15c2021-09-13 09:38:05 +02002657 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2658 make test
2659}
2660
Valerio Setti44b178c2023-03-22 14:02:57 +01002661component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002662 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002663
2664 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002665 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002666 $(helper_get_psa_key_type_list "ECC") \
2667 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002668
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002669 # Configure
2670 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002671
Ronald Cron46ac0652024-03-18 12:39:04 +01002672 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002673 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002674
Valerio Setti44b178c2023-03-22 14:02:57 +01002675 # Disable the module that's accelerated
2676 scripts/config.py unset MBEDTLS_ECDH_C
2677
2678 # Disable things that depend on it
2679 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2680 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2682 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2683 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2684
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002685 # Build
2686 # -----
2687
2688 helper_libtestdriver1_make_drivers "$loc_accel_list"
2689
Valerio Setti3fe105b2023-10-30 11:08:12 +01002690 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002691
Valerio Setti44b178c2023-03-22 14:02:57 +01002692 # Make sure this was not re-enabled by accident (additive config)
2693 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002694
2695 # Run the tests
2696 # -------------
2697
Valerio Setti44b178c2023-03-22 14:02:57 +01002698 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002699 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002700}
2701
Przemek Stekieldccb2022023-05-11 10:48:50 +02002702component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002703 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002704
2705 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002706 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002707 $(helper_get_psa_key_type_list "DH") \
2708 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002709
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002710 # Configure
2711 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002712
Przemek Stekiel565353e2023-07-05 11:07:07 +02002713 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002714 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002715
2716 # Disable the module that's accelerated
2717 scripts/config.py unset MBEDTLS_DHM_C
2718
2719 # Disable things that depend on it
2720 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2721 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2722
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002723 # Build
2724 # -----
2725
2726 helper_libtestdriver1_make_drivers "$loc_accel_list"
2727
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002728 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002729
2730 # Make sure this was not re-enabled by accident (additive config)
2731 not grep mbedtls_dhm_ library/dhm.o
2732
2733 # Run the tests
2734 # -------------
2735
Gilles Peskine14302ed2023-07-19 19:30:04 +02002736 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002737 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002738
Gilles Peskine14302ed2023-07-19 19:30:04 +02002739 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002740 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002741}
2742
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002743component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002744 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002745
2746 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002747 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002748
2749 # Disable things that are not supported
2750 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2751 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002752 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002753
Gilles Peskine14302ed2023-07-19 19:30:04 +02002754 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002755 make test
2756
Gilles Peskine14302ed2023-07-19 19:30:04 +02002757 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002758 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002759}
2760
Valerio Setti44b178c2023-03-22 14:02:57 +01002761component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002762 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002763
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002764 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002765 $(helper_get_psa_key_type_list "ECC") \
2766 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002767
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002768 # Configure
2769 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002770
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002771 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002772
2773 # Make built-in fallback not available
2774 scripts/config.py unset MBEDTLS_ECJPAKE_C
2775 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2776
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002777 # Build
2778 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002779
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002780 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002781
Valerio Setti3fe105b2023-10-30 11:08:12 +01002782 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002783
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002784 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002785 not grep mbedtls_ecjpake_init library/ecjpake.o
2786
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002787 # Run the tests
2788 # -------------
2789
Gilles Peskine14302ed2023-07-19 19:30:04 +02002790 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002791 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002792}
2793
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002794component_test_psa_crypto_config_accel_ecc_some_key_types () {
2795 msg "build: full with accelerated EC algs and some key types"
2796
2797 # Algorithms and key types to accelerate
2798 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2799 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2800 ALG_ECDH \
2801 ALG_JPAKE \
2802 KEY_TYPE_ECC_PUBLIC_KEY \
2803 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2804 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002805 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2806 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002807
2808 # Configure
2809 # ---------
2810
2811 # start with config full for maximum coverage (also enables USE_PSA)
2812 helper_libtestdriver1_adjust_config "full"
2813
2814 # Disable modules that are accelerated - some will be re-enabled
2815 scripts/config.py unset MBEDTLS_ECDSA_C
2816 scripts/config.py unset MBEDTLS_ECDH_C
2817 scripts/config.py unset MBEDTLS_ECJPAKE_C
2818 scripts/config.py unset MBEDTLS_ECP_C
2819
2820 # Disable all curves - those that aren't accelerated should be re-enabled
2821 helper_disable_builtin_curves
2822
2823 # Restartable feature is not yet supported by PSA. Once it will in
2824 # the future, the following line could be removed (see issues
2825 # 6061, 6332 and following ones)
2826 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2827
2828 # this is not supported by the driver API yet
2829 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2830
2831 # Build
2832 # -----
2833
2834 # These hashes are needed for some ECDSA signature tests.
2835 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2836 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2837 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2838
Valerio Setti3fe105b2023-10-30 11:08:12 +01002839 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002840
2841 # ECP should be re-enabled but not the others
2842 not grep mbedtls_ecdh_ library/ecdh.o
2843 not grep mbedtls_ecdsa library/ecdsa.o
2844 not grep mbedtls_ecjpake library/ecjpake.o
2845 grep mbedtls_ecp library/ecp.o
2846
2847 # Run the tests
2848 # -------------
2849
2850 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002851 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002852}
2853
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002854# Run tests with only (non-)Weierstrass accelerated
2855# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002856# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2857# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002858common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002859 weierstrass=$1
2860 if [ $weierstrass -eq 1 ]; then
2861 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002862 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002863 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002864 fi
2865
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002866 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002867
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002868 # Note: Curves are handled in a special way by the libtestdriver machinery,
2869 # so we only want to include them in the accel list when building the main
2870 # libraries, hence the use of a separate variable.
2871 # Note: the following loop is a modified version of
2872 # helper_get_psa_curve_list that only keeps Weierstrass families.
2873 loc_weierstrass_list=""
2874 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002875 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2876 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002877 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002878 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002879 ;;
2880 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002881 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002882 ;;
2883 esac
2884 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002885 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002886 loc_curve_list=$loc_weierstrass_list
2887 else
2888 loc_curve_list=$loc_non_weierstrass_list
2889 fi
2890
Valerio Setti3fe105b2023-10-30 11:08:12 +01002891 # Algorithms and key types to accelerate
2892 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2893 ALG_ECDH \
2894 ALG_JPAKE \
2895 $(helper_get_psa_key_type_list "ECC") \
2896 $loc_curve_list"
2897
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002898 # Configure
2899 # ---------
2900
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002901 # Start with config crypto_full and remove PK_C:
2902 # that's what's supported now, see docs/driver-only-builds.md.
2903 helper_libtestdriver1_adjust_config "crypto_full"
2904 scripts/config.py unset MBEDTLS_PK_C
2905 scripts/config.py unset MBEDTLS_PK_PARSE_C
2906 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002907
2908 # Disable modules that are accelerated - some will be re-enabled
2909 scripts/config.py unset MBEDTLS_ECDSA_C
2910 scripts/config.py unset MBEDTLS_ECDH_C
2911 scripts/config.py unset MBEDTLS_ECJPAKE_C
2912 scripts/config.py unset MBEDTLS_ECP_C
2913
2914 # Disable all curves - those that aren't accelerated should be re-enabled
2915 helper_disable_builtin_curves
2916
2917 # Restartable feature is not yet supported by PSA. Once it will in
2918 # the future, the following line could be removed (see issues
2919 # 6061, 6332 and following ones)
2920 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2921
2922 # this is not supported by the driver API yet
2923 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2924
2925 # Build
2926 # -----
2927
2928 # These hashes are needed for some ECDSA signature tests.
2929 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2930 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2931 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2932
Valerio Settiac7a8092023-10-31 12:23:44 +01002933 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002934
2935 # We expect ECDH to be re-enabled for the missing curves
2936 grep mbedtls_ecdh_ library/ecdh.o
2937 # We expect ECP to be re-enabled, however the parts specific to the
2938 # families of curves that are accelerated should be ommited.
2939 # - functions with mxz in the name are specific to Montgomery curves
2940 # - ecp_muladd is specific to Weierstrass curves
2941 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002942 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002943 not grep mbedtls_ecp_muladd library/ecp.o
2944 grep mxz library/ecp.o
2945 else
2946 grep mbedtls_ecp_muladd library/ecp.o
2947 not grep mxz library/ecp.o
2948 fi
2949 # We expect ECDSA and ECJPAKE to be re-enabled only when
2950 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002951 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002952 not grep mbedtls_ecdsa library/ecdsa.o
2953 not grep mbedtls_ecjpake library/ecjpake.o
2954 else
2955 grep mbedtls_ecdsa library/ecdsa.o
2956 grep mbedtls_ecjpake library/ecjpake.o
2957 fi
2958
2959 # Run the tests
2960 # -------------
2961
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002962 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2963 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002964}
2965
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002966component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002967 common_test_psa_crypto_config_accel_ecc_some_curves 1
2968}
2969
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002970component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002971 common_test_psa_crypto_config_accel_ecc_some_curves 0
2972}
2973
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002974# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2975# ECDH, ECDSA) with and without drivers.
2976# The input parameter is a boolean value which indicates:
2977# - 0 keep built-in EC algs,
2978# - 1 exclude built-in EC algs (driver only).
2979#
2980# This is used by the two following components to ensure they always use the
2981# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002982# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2983# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002984# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002985config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002986 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002987 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002988 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002989 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002990 # Disable modules that are accelerated
2991 scripts/config.py unset MBEDTLS_ECDSA_C
2992 scripts/config.py unset MBEDTLS_ECDH_C
2993 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002994 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002995 fi
2996
2997 # Restartable feature is not yet supported by PSA. Once it will in
2998 # the future, the following line could be removed (see issues
2999 # 6061, 6332 and following ones)
3000 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003001}
3002
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003003# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3004component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003005 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003006
3007 # Algorithms and key types to accelerate
3008 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3009 ALG_ECDH \
3010 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003011 $(helper_get_psa_key_type_list "ECC") \
3012 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003013
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003014 # Configure
3015 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003016
3017 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003018 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003019
Valerio Setti0a342c92023-09-01 09:12:31 +02003020 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003021 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3022 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003023
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003024 # Build
3025 # -----
3026
3027 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003028 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3029 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003030 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3031
Valerio Setti3fe105b2023-10-30 11:08:12 +01003032 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003033
3034 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3035 not grep mbedtls_ecdsa_ library/ecdsa.o
3036 not grep mbedtls_ecdh_ library/ecdh.o
3037 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003038 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003039
3040 # Run the tests
3041 # -------------
3042
Gilles Peskine14302ed2023-07-19 19:30:04 +02003043 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003044 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003045
Gilles Peskine14302ed2023-07-19 19:30:04 +02003046 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003047 tests/ssl-opt.sh
3048}
3049
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003050# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3051component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003052 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003053
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003054 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003055
Gilles Peskine21570cf2023-12-22 11:49:50 +01003056 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003057
Gilles Peskine14302ed2023-07-19 19:30:04 +02003058 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003059 make test
3060
Gilles Peskine14302ed2023-07-19 19:30:04 +02003061 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003062 tests/ssl-opt.sh
3063}
3064
Valerio Settie618cb02023-04-12 14:59:16 +02003065# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003066# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3067# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003068# to ensure that both tests use the same underlying configuration when testing
3069# driver's coverage with analyze_outcomes.py.
3070#
3071# This functions accepts 1 boolean parameter as follows:
3072# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3073# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3074# - 0: include built-in implementation of EC algorithms.
3075#
3076# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3077# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003078config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003079 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003080 # start with full config for maximum coverage (also enables USE_PSA)
3081 helper_libtestdriver1_adjust_config "full"
3082
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003083 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003084 # Disable modules that are accelerated
3085 scripts/config.py unset MBEDTLS_ECDSA_C
3086 scripts/config.py unset MBEDTLS_ECDH_C
3087 scripts/config.py unset MBEDTLS_ECJPAKE_C
3088 # Disable ECP module (entirely)
3089 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003090 fi
3091
Valerio Settiaecd32c2023-06-14 10:42:31 +02003092 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3093 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003094 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003095 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003096
Valerio Settie618cb02023-04-12 14:59:16 +02003097 # Restartable feature is not yet supported by PSA. Once it will in
3098 # the future, the following line could be removed (see issues
3099 # 6061, 6332 and following ones)
3100 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003101}
3102
3103# Build and test a configuration where driver accelerates all EC algs while
3104# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3105# side.
3106#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003107# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3108component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003109 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003110
3111 # Algorithms and key types to accelerate
3112 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3113 ALG_ECDH \
3114 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003115 $(helper_get_psa_key_type_list "ECC") \
3116 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003117
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003118 # Configure
3119 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003120
Valerio Settie618cb02023-04-12 14:59:16 +02003121 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003122 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003123 # Disable all the builtin curves. All the required algs are accelerated.
3124 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003125
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003126 # Build
3127 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003128
3129 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003130 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3131 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3132 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003133
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003134 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003135
Valerio Setti3fe105b2023-10-30 11:08:12 +01003136 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003137
3138 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3139 not grep mbedtls_ecdsa_ library/ecdsa.o
3140 not grep mbedtls_ecdh_ library/ecdh.o
3141 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003142 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003143 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003144
3145 # Run the tests
3146 # -------------
3147
Gilles Peskine14302ed2023-07-19 19:30:04 +02003148 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003149 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003150
Gilles Peskine14302ed2023-07-19 19:30:04 +02003151 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003152 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003153}
3154
3155# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003156# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003157# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003158component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003159 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003160
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003161 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003162
Gilles Peskine21570cf2023-12-22 11:49:50 +01003163 make
Valerio Settie618cb02023-04-12 14:59:16 +02003164
Gilles Peskine14302ed2023-07-19 19:30:04 +02003165 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003166 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003167
Gilles Peskine14302ed2023-07-19 19:30:04 +02003168 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003169 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003170}
3171
Valerio Setti4e2f2442023-08-15 10:10:26 +02003172# This is a common configuration helper used directly from:
3173# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3174# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3175# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003176# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003177# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003178# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003179# - this is the reference component of the above
3180# - it still disables RSA and FFDH, but it uses builtin EC algs
3181# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3182# - accelerate all EC and FFDH algs, disable only RSA
3183# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3184# - this is the reference component of the above
3185# - it still disables RSA, but it uses builtin EC and FFDH algs
3186#
3187# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003188# $1: a boolean value which states if we are testing an accelerated scenario
3189# or not.
3190# $2: a string value which states which components are tested. Allowed values
3191# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003192config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003193 driver_only="$1"
3194 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003195 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003196 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003197
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003198 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003199 # Disable modules that are accelerated
3200 scripts/config.py unset MBEDTLS_ECDSA_C
3201 scripts/config.py unset MBEDTLS_ECDH_C
3202 scripts/config.py unset MBEDTLS_ECJPAKE_C
3203 # Disable ECP module (entirely)
3204 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003205 # Also disable bignum
3206 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003207 fi
3208
3209 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3210 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3211 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3212 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3213
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003214 # RSA support is intentionally disabled on this test because RSA_C depends
3215 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003216 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3217 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 +02003218 scripts/config.py unset MBEDTLS_RSA_C
3219 scripts/config.py unset MBEDTLS_PKCS1_V15
3220 scripts/config.py unset MBEDTLS_PKCS1_V21
3221 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3222 # Also disable key exchanges that depend on RSA
3223 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3224 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3225 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3226 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3227 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3228
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003229 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003230 # When testing ECC only, we disable FFDH support, both from builtin and
3231 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003232 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003233 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 +01003234 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003235 scripts/config.py unset MBEDTLS_DHM_C
3236 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3237 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3238 else
3239 # When testing ECC and DH instead, we disable DHM and depending key
3240 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003241 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003242 scripts/config.py unset MBEDTLS_DHM_C
3243 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3244 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3245 fi
3246 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003247
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003248 # Restartable feature is not yet supported by PSA. Once it will in
3249 # the future, the following line could be removed (see issues
3250 # 6061, 6332 and following ones)
3251 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3252}
3253
Valerio Setti4e2f2442023-08-15 10:10:26 +02003254# Common helper used by:
3255# - component_test_psa_crypto_config_accel_ecc_no_bignum
3256# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003257#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003258# The goal is to build and test accelerating either:
3259# - ECC only or
3260# - both ECC and FFDH
3261#
3262# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003263# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3264# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003265common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003266 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003267
Valerio Setti5dfaca42023-09-05 08:48:51 +02003268 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003269 if [ "$test_target" = "ECC_DH" ]; then
3270 accel_text="ECC/FFDH"
3271 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003272 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003273 accel_text="ECC"
3274 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003275 fi
3276
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003277 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003278
3279 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003280 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3281 ALG_ECDH \
3282 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003283 $(helper_get_psa_key_type_list "ECC") \
3284 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003285 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003286 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003287 loc_accel_list="$loc_accel_list \
3288 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003289 $(helper_get_psa_key_type_list "DH") \
3290 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003291 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003292
3293 # Configure
3294 # ---------
3295
3296 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003297 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003298 # Disable all the builtin curves. All the required algs are accelerated.
3299 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003300
3301 # Build
3302 # -----
3303
3304 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003305 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3306 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3307 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003308
3309 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3310
Valerio Setti3fe105b2023-10-30 11:08:12 +01003311 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003312
3313 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3314 not grep mbedtls_ecdsa_ library/ecdsa.o
3315 not grep mbedtls_ecdh_ library/ecdh.o
3316 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003317 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003318 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003319 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003320 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003321 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003322
3323 # Run the tests
3324 # -------------
3325
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003326 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003327
Gilles Peskine21570cf2023-12-22 11:49:50 +01003328 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003329
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003330 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003331 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003332}
3333
Valerio Setti4e2f2442023-08-15 10:10:26 +02003334# Common helper used by:
3335# - component_test_psa_crypto_config_reference_ecc_no_bignum
3336# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3337#
3338# The goal is to build and test a reference scenario (i.e. with builtin
3339# components) compared to the ones used in
3340# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3341#
3342# It is meant to be used in conjunction with
3343# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3344# coverage analysis in "analyze_outcomes.py" script.
3345common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003346 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003347
Valerio Setti5dfaca42023-09-05 08:48:51 +02003348 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003349 if [ "$test_target" = "ECC_DH" ]; then
3350 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003351 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003352 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003353 fi
3354
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003355 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003356
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003357 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003358
Gilles Peskine21570cf2023-12-22 11:49:50 +01003359 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003360
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003361 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003362 make test
3363
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003364 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003365 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003366}
3367
Valerio Setti4e2f2442023-08-15 10:10:26 +02003368component_test_psa_crypto_config_accel_ecc_no_bignum () {
3369 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3370}
3371
3372component_test_psa_crypto_config_reference_ecc_no_bignum () {
3373 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3374}
3375
3376component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3377 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3378}
3379
3380component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3381 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3382}
3383
Valerio Settiac6d35f2023-08-04 12:49:11 +02003384# Helper for setting common configurations between:
3385# - component_test_tfm_config_p256m_driver_accel_ec()
3386# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003387common_tfm_config () {
3388 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003389 cp configs/config-tfm.h "$CONFIG_H"
3390 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3391 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003392
Yanray Wang73bb2312023-09-25 11:21:15 +08003393 # Other config adjustment to make the tests pass.
3394 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003395 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003396 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3397 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003398
Yanray Wang73bb2312023-09-25 11:21:15 +08003399 # Config adjustment for better test coverage in our environment.
3400 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003401 #
3402 # Enable filesystem I/O for the benefit of PK parse/write tests.
3403 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3404}
3405
Valerio Settiac6d35f2023-08-04 12:49:11 +02003406# Keep this in sync with component_test_tfm_config() as they are both meant
3407# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003408component_test_tfm_config_p256m_driver_accel_ec () {
3409 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3410
3411 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003412
Dave Rodgman897bb772023-11-15 16:34:20 +00003413 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003414 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003415
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003416 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3417 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003418 not grep mbedtls_ecdh_ library/ecdh.o
3419 not grep mbedtls_ecjpake_ library/ecjpake.o
3420 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3421 not grep mbedtls_ecp_ library/ecp.o
3422 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003423 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003424 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003425 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003426 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003427
Valerio Setti5e18b902023-12-04 12:07:30 +01003428 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3429 # files, so we want to ensure that it has not be re-enabled accidentally.
3430 not grep mbedtls_cipher library/cipher.o
3431
Valerio Settib7e95442023-03-21 11:52:33 +01003432 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003433 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003434 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003435}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003436
Valerio Settiac6d35f2023-08-04 12:49:11 +02003437# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3438# they are both meant to be used in analyze_outcomes.py for driver's coverage
3439# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003440component_test_tfm_config() {
3441 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003442
Dave Rodgman897bb772023-11-15 16:34:20 +00003443 # Disable P256M driver, which is on by default, so that analyze_outcomes
3444 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3445 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3446
Valerio Setti52ba0e32023-08-04 12:43:03 +02003447 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003448 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003449
Dave Rodgman897bb772023-11-15 16:34:20 +00003450 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003451 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003452
Valerio Setti5e18b902023-12-04 12:07:30 +01003453 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3454 # files, so we want to ensure that it has not be re-enabled accidentally.
3455 not grep mbedtls_cipher library/cipher.o
3456
Valerio Setti52ba0e32023-08-04 12:43:03 +02003457 msg "test: TF-M config"
3458 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003459}
3460
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003461# Common helper for component_full_without_ecdhe_ecdsa() and
3462# component_full_without_ecdhe_ecdsa_and_tls13() which:
3463# - starts from the "full" configuration minus the list of symbols passed in
3464# as 1st parameter
3465# - build
3466# - test only TLS (i.e. test_suite_tls and ssl-opt)
3467build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003468 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003469
3470 msg "build: full minus something, test TLS"
3471
3472 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003473 for sym in $symbols_to_disable; do
3474 echo "Disabling $sym"
3475 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003476 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003477
Gilles Peskine21570cf2023-12-22 11:49:50 +01003478 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003479
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003480 msg "test: full minus something, test TLS"
3481 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003482
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003483 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003484 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003485}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003486
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003487component_full_without_ecdhe_ecdsa () {
3488 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003489}
3490
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003491component_full_without_ecdhe_ecdsa_and_tls13 () {
3492 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3493 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003494}
3495
Valerio Setti249b18a2023-06-20 12:08:30 +02003496# This is an helper used by:
3497# - component_test_psa_ecc_key_pair_no_derive
3498# - component_test_psa_ecc_key_pair_no_generate
3499# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3500# enabled, but one. Input arguments are as follows:
3501# - $1 is the key type under test, i.e. ECC/RSA/DH
3502# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003503build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003504 key_type=$1
3505 unset_option=$2
3506 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003507
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003508 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003509 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003510 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3511 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3512
3513 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3514 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003515 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003516
Gilles Peskine21570cf2023-12-22 11:49:50 +01003517 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003518
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003519 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003520 make test
3521}
3522
3523component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003524 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003525}
3526
3527component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003528 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003529}
3530
Pengyu Lve705f572023-12-06 16:38:15 +08003531config_psa_crypto_accel_rsa () {
3532 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003533
Pengyu Lve705f572023-12-06 16:38:15 +08003534 # Start from crypto_full config (no X.509, no TLS)
3535 helper_libtestdriver1_adjust_config "crypto_full"
3536
3537 if [ "$driver_only" -eq 1 ]; then
3538 # Remove RSA support and its dependencies
3539 scripts/config.py unset MBEDTLS_RSA_C
3540 scripts/config.py unset MBEDTLS_PKCS1_V15
3541 scripts/config.py unset MBEDTLS_PKCS1_V21
3542
3543 # We need PEM parsing in the test library as well to support the import
3544 # of PEM encoded RSA keys.
3545 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3546 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3547 fi
3548}
3549
3550component_test_psa_crypto_config_accel_rsa_crypto () {
3551 msg "build: crypto_full with accelerated RSA"
3552
3553 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3554 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3555 KEY_TYPE_RSA_PUBLIC_KEY \
3556 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3557 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3558 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3559 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003560
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003561 # Configure
3562 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003563
Pengyu Lve705f572023-12-06 16:38:15 +08003564 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003565
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003566 # Build
3567 # -----
3568
Pengyu Lve705f572023-12-06 16:38:15 +08003569 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003570 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 +08003571 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003572 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003573
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003574 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003575
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003576 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003577 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003578
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003579 # Run the tests
3580 # -------------
3581
Pengyu Lve705f572023-12-06 16:38:15 +08003582 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003583 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003584}
3585
3586component_test_psa_crypto_config_reference_rsa_crypto () {
3587 msg "build: crypto_full with non-accelerated RSA"
3588
3589 # Configure
3590 # ---------
3591 config_psa_crypto_accel_rsa 0
3592
3593 # Build
3594 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003595 make
Pengyu Lve705f572023-12-06 16:38:15 +08003596
3597 # Run the tests
3598 # -------------
3599 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003600 make test
3601}
3602
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003603# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003604# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003605component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003606 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003607
Valerio Setti4590bc22023-06-13 15:39:23 +02003608 # Create a temporary output file unless there is already one set
3609 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3610 REMOVE_OUTCOME_ON_EXIT="no"
3611 else
3612 REMOVE_OUTCOME_ON_EXIT="yes"
3613 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3614 export MBEDTLS_TEST_OUTCOME_FILE
3615 fi
3616
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003617 # Start from crypto configuration
3618 scripts/config.py crypto
3619
3620 # Remove RSA support and its dependencies
3621 scripts/config.py unset MBEDTLS_PKCS1_V15
3622 scripts/config.py unset MBEDTLS_PKCS1_V21
3623 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3624 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3625 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3626 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3627 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3628 scripts/config.py unset MBEDTLS_RSA_C
3629 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3630
3631 # Enable PSA support
3632 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3633
Valerio Setti01cc88a2023-06-15 11:53:08 +02003634 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003635 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003636 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3637 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3638 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003639
3640 make
3641
Valerio Setti01cc88a2023-06-15 11:53:08 +02003642 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003643 make test
3644
3645 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3646 # performing RSA signature.
3647 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3648 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3649
3650 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3651 rm $MBEDTLS_TEST_OUTCOME_FILE
3652 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003653}
3654
Ronald Cronb2312452021-05-08 14:32:59 +02003655component_test_psa_crypto_config_accel_hash () {
3656 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3657
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003658 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3659 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3660 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003661
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003662 # Configure
3663 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003664
Ronald Cron46ac0652024-03-18 12:39:04 +01003665 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003666 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003667
3668 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003669 scripts/config.py unset MBEDTLS_MD5_C
3670 scripts/config.py unset MBEDTLS_RIPEMD160_C
3671 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003672 scripts/config.py unset MBEDTLS_SHA224_C
3673 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003674 scripts/config.py unset MBEDTLS_SHA384_C
3675 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003676 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003677
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003678 # Build
3679 # -----
3680
3681 helper_libtestdriver1_make_drivers "$loc_accel_list"
3682
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003683 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003684
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003685 # There's a risk of something getting re-enabled via config_psa.h;
3686 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3687 not grep mbedtls_md5 library/md5.o
3688 not grep mbedtls_sha1 library/sha1.o
3689 not grep mbedtls_sha256 library/sha256.o
3690 not grep mbedtls_sha512 library/sha512.o
3691 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003692
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003693 # Run the tests
3694 # -------------
3695
Ronald Cronb2312452021-05-08 14:32:59 +02003696 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3697 make test
3698}
3699
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003700# Auxiliary function to build config for hashes with and without drivers
3701config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003702 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003703 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003704 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003705 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003706 # disable the built-in implementation of hashes
3707 scripts/config.py unset MBEDTLS_MD5_C
3708 scripts/config.py unset MBEDTLS_RIPEMD160_C
3709 scripts/config.py unset MBEDTLS_SHA1_C
3710 scripts/config.py unset MBEDTLS_SHA224_C
3711 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003712 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003713 scripts/config.py unset MBEDTLS_SHA384_C
3714 scripts/config.py unset MBEDTLS_SHA512_C
3715 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003716 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003717 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003718}
3719
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003720# Note that component_test_psa_crypto_config_reference_hash_use_psa
3721# is related to this component and both components need to be kept in sync.
3722# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003723component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003724 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003725
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003726 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3727 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3728 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003729
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003730 # Configure
3731 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003732
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003733 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003734
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003735 # Build
3736 # -----
3737
3738 helper_libtestdriver1_make_drivers "$loc_accel_list"
3739
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003740 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003741
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003742 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003743 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003744 not grep mbedtls_md5 library/md5.o
3745 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003746 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003747 not grep mbedtls_sha512 library/sha512.o
3748 not grep mbedtls_ripemd160 library/ripemd160.o
3749
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003750 # Run the tests
3751 # -------------
3752
Gilles Peskine14302ed2023-07-19 19:30:04 +02003753 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003754 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003755
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003756 # This is mostly useful so that we can later compare outcome files with
3757 # the reference config in analyze_outcomes.py, to check that the
3758 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003759 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003760 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003761
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003762 # This is to make sure all ciphersuites are exercised, but we don't need
3763 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003764 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003765 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003766}
3767
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003768# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3769# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3770# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3771# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003772component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003773 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003774
3775 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003776
Gilles Peskine21570cf2023-12-22 11:49:50 +01003777 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003778
Gilles Peskine14302ed2023-07-19 19:30:04 +02003779 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003780 make test
3781
Gilles Peskine14302ed2023-07-19 19:30:04 +02003782 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003783 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003784}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003785
Valerio Setti8eb310c2024-01-22 16:22:57 +01003786# Auxiliary function to build config for hashes with and without drivers
3787config_psa_crypto_hmac_use_psa () {
3788 driver_only="$1"
3789 # start with config full for maximum coverage (also enables USE_PSA)
3790 helper_libtestdriver1_adjust_config "full"
3791
Valerio Setticd89b0b2024-01-24 14:24:55 +01003792 if [ "$driver_only" -eq 1 ]; then
3793 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3794 # is still enabled though (for ENTROPY_C among others).
3795 scripts/config.py unset MBEDTLS_MD_C
3796 # Disable also the builtin hashes since they are supported by the driver
3797 # and MD module is able to perform PSA dispathing.
3798 scripts/config.py unset-all MBEDTLS_SHA
3799 scripts/config.py unset MBEDTLS_MD5_C
3800 scripts/config.py unset MBEDTLS_RIPEMD160_C
3801 fi
3802
Valerio Setti8eb310c2024-01-22 16:22:57 +01003803 # Direct dependencies of MD_C. We disable them also in the reference
3804 # component to work with the same set of features.
3805 scripts/config.py unset MBEDTLS_PKCS7_C
3806 scripts/config.py unset MBEDTLS_PKCS5_C
3807 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3808 scripts/config.py unset MBEDTLS_HKDF_C
3809 # Dependencies of HMAC_DRBG
3810 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3811 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3812}
3813
3814component_test_psa_crypto_config_accel_hmac() {
3815 msg "test: full with accelerated hmac"
3816
3817 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3818 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3819 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3820 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3821
3822 # Configure
3823 # ---------
3824
3825 config_psa_crypto_hmac_use_psa 1
3826
Valerio Setti8eb310c2024-01-22 16:22:57 +01003827 # Build
3828 # -----
3829
3830 helper_libtestdriver1_make_drivers "$loc_accel_list"
3831
3832 helper_libtestdriver1_make_main "$loc_accel_list"
3833
3834 # Ensure that built-in support for HMAC is disabled.
3835 not grep mbedtls_md_hmac library/md.o
3836
3837 # Run the tests
3838 # -------------
3839
3840 msg "test: full with accelerated hmac"
3841 make test
3842}
3843
3844component_test_psa_crypto_config_reference_hmac() {
3845 msg "test: full without accelerated hmac"
3846
3847 config_psa_crypto_hmac_use_psa 0
3848
3849 make
3850
3851 msg "test: full without accelerated hmac"
3852 make test
3853}
3854
Valerio Setti9da01a72023-12-18 17:38:18 +01003855component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003856 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003857
Valerio Setti9da01a72023-12-18 17:38:18 +01003858 # Albeit this components aims at accelerating DES which should only support
3859 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3860 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003861 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3862 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3863 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003864
Valerio Setti9da01a72023-12-18 17:38:18 +01003865 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3866 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3867 # of this component. This limitation will be addressed by #8598.
3868
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003869 # Configure
3870 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003871
Valerio Setti9a427302023-10-17 11:40:42 +02003872 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003873 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003874
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003875 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003876 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3877 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3878 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3879 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3880 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3881 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3882 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003883 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003884
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003885 # Build
3886 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003887
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003888 helper_libtestdriver1_make_drivers "$loc_accel_list"
3889
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003890 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003891
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003892 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003893 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003894
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003895 # Run the tests
3896 # -------------
3897
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003898 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003899 make test
3900}
3901
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003902component_test_psa_crypto_config_accel_aead () {
3903 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3904
Valerio Setti3f02bb72023-10-02 15:57:33 +02003905 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3906 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003907
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003908 # Configure
3909 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003910
Valerio Setti3f02bb72023-10-02 15:57:33 +02003911 # Start from full config
3912 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003913
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003914 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003915 scripts/config.py unset MBEDTLS_GCM_C
3916 scripts/config.py unset MBEDTLS_CCM_C
3917 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003918
Valerio Settia50b89e2023-11-08 15:58:47 +01003919 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3920 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003921
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003922 # Build
3923 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003924
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003925 helper_libtestdriver1_make_drivers "$loc_accel_list"
3926
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003927 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003928
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003929 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003930 not grep mbedtls_ccm library/ccm.o
3931 not grep mbedtls_gcm library/gcm.o
3932 not grep mbedtls_chachapoly library/chachapoly.o
3933
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003934 # Run the tests
3935 # -------------
3936
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003937 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3938 make test
3939}
3940
Valerio Settib680fc42023-10-13 09:29:37 +02003941# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003942# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3943# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3944common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003945 # Start from the full config
3946 helper_libtestdriver1_adjust_config "full"
3947
Valerio Settib680fc42023-10-13 09:29:37 +02003948 scripts/config.py unset MBEDTLS_NIST_KW_C
3949}
3950
Valerio Settib6b301f2023-10-04 12:05:05 +02003951# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003952# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3953# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003954# are meant to be used together in analyze_outcomes.py script in order to test
3955# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003956component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3957 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003958
Valerio Settiad8b7f02023-10-25 12:39:50 +02003959 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 +01003960 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003961 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003962 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3963
3964 # Configure
3965 # ---------
3966
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003967 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003968
3969 # Disable the things that are being accelerated
3970 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3971 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3972 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3973 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3974 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3975 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3976 scripts/config.py unset MBEDTLS_GCM_C
3977 scripts/config.py unset MBEDTLS_CCM_C
3978 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003979 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003980 scripts/config.py unset MBEDTLS_DES_C
3981 scripts/config.py unset MBEDTLS_AES_C
3982 scripts/config.py unset MBEDTLS_ARIA_C
3983 scripts/config.py unset MBEDTLS_CHACHA20_C
3984 scripts/config.py unset MBEDTLS_CAMELLIA_C
3985
Valerio Settiec9b2582023-11-08 16:50:54 +01003986 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3987 # does not depend on it.
3988 scripts/config.py unset MBEDTLS_CIPHER_C
3989
Valerio Settib6b301f2023-10-04 12:05:05 +02003990 # Build
3991 # -----
3992
3993 helper_libtestdriver1_make_drivers "$loc_accel_list"
3994
3995 helper_libtestdriver1_make_main "$loc_accel_list"
3996
3997 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003998 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003999 not grep mbedtls_des library/des.o
4000 not grep mbedtls_aes library/aes.o
4001 not grep mbedtls_aria library/aria.o
4002 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004003 not grep mbedtls_ccm library/ccm.o
4004 not grep mbedtls_gcm library/gcm.o
4005 not grep mbedtls_chachapoly library/chachapoly.o
4006 not grep mbedtls_cmac library/cmac.o
4007
4008 # Run the tests
4009 # -------------
4010
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004011 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004012 make test
Valerio Settif9414552023-11-09 10:43:20 +01004013
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004014 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004015 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004016
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004017 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004018 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004019}
4020
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004021component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4022 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4023 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004024
Gilles Peskine21570cf2023-12-22 11:49:50 +01004025 make
Valerio Settif9414552023-11-09 10:43:20 +01004026
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004027 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004028 make test
Valerio Settif9414552023-11-09 10:43:20 +01004029
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004030 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004031 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004032
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004033 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004034 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004035}
4036
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004037common_block_cipher_dispatch() {
4038 TEST_WITH_DRIVER="$1"
4039
4040 # Start from the full config
4041 helper_libtestdriver1_adjust_config "full"
4042
4043 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4044 # Disable key types that are accelerated (there is no legacy equivalent
4045 # symbol for ECB)
4046 scripts/config.py unset MBEDTLS_AES_C
4047 scripts/config.py unset MBEDTLS_ARIA_C
4048 scripts/config.py unset MBEDTLS_CAMELLIA_C
4049 fi
4050
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004051 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004052 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004053 # Keep this also in the reference component in order to skip the same tests
4054 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004055 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4056 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4057 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4058 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4059 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4060 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4061 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02004062 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004063
4064 # Disable direct dependency on AES_C
4065 scripts/config.py unset MBEDTLS_NIST_KW_C
4066
4067 # Prevent the cipher module from using deprecated PSA path. The reason is
4068 # that otherwise there will be tests relying on "aes_info" (defined in
4069 # "cipher_wrap.c") whose functions are not available when AES_C is
4070 # not defined. ARIA and Camellia are not a problem in this case because
4071 # the PSA path is not tested for these key types.
4072 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4073}
4074
Valerio Settif8e6cba2023-12-12 11:53:39 +01004075component_test_full_block_cipher_psa_dispatch () {
4076 msg "build: full + PSA dispatch in block_cipher"
4077
4078 loc_accel_list="ALG_ECB_NO_PADDING \
4079 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4080
4081 # Configure
4082 # ---------
4083
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004084 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004085
Valerio Settif8e6cba2023-12-12 11:53:39 +01004086 # Build
4087 # -----
4088
4089 helper_libtestdriver1_make_drivers "$loc_accel_list"
4090
4091 helper_libtestdriver1_make_main "$loc_accel_list"
4092
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004093 # Make sure disabled components were not re-enabled by accident (additive
4094 # config)
4095 not grep mbedtls_aes_ library/aes.o
4096 not grep mbedtls_aria_ library/aria.o
4097 not grep mbedtls_camellia_ library/camellia.o
4098
Valerio Settif8e6cba2023-12-12 11:53:39 +01004099 # Run the tests
4100 # -------------
4101
4102 msg "test: full + PSA dispatch in block_cipher"
4103 make test
4104}
4105
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004106# This is the reference component of component_test_full_block_cipher_psa_dispatch
4107component_test_full_block_cipher_legacy_dispatch () {
4108 msg "build: full + legacy dispatch in block_cipher"
4109
4110 common_block_cipher_dispatch 0
4111
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004112 make
4113
4114 msg "test: full + legacy dispatch in block_cipher"
4115 make test
4116}
4117
Gilles Peskine36dea152023-07-20 22:19:45 +02004118component_test_aead_chachapoly_disabled() {
4119 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004120 scripts/config.py full
4121 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004122 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004123 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004124
Gilles Peskine36dea152023-07-20 22:19:45 +02004125 msg "test: full minus CHACHAPOLY"
4126 make test
4127}
4128
4129component_test_aead_only_ccm() {
4130 msg "build: full minus CHACHAPOLY and GCM"
4131 scripts/config.py full
4132 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4133 scripts/config.py unset MBEDTLS_GCM_C
4134 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4135 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004136 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004137
4138 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004139 make test
4140}
4141
Ronald Crone501d0e2023-07-10 08:31:19 +02004142component_test_ccm_aes_sha256() {
4143 msg "build: CCM + AES + SHA256 configuration"
4144
Ronald Cron7612d8c2023-07-20 10:03:54 +02004145 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004146 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004147
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004148 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004149
4150 msg "test: CCM + AES + SHA256 configuration"
4151 make test
4152}
4153
Dave Rodgman904c5892023-06-28 17:36:02 +01004154support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004155 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004156}
4157
Dave Rodgman904c5892023-06-28 17:36:02 +01004158component_build_tfm_armcc() {
4159 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004160 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004161
Dave Rodgman88651c42023-06-29 12:35:51 +01004162 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004163 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 +01004164}
4165
4166component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004167 # Check that the TF-M configuration can build cleanly with various
4168 # warning flags enabled. We don't build or run tests, since the
4169 # TF-M configuration needs a TF-M platform. A tweaked version of
4170 # the configuration that works on mainstream platforms is in
4171 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004172 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004173
Dave Rodgman88651c42023-06-29 12:35:51 +01004174 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004175 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 +01004176
Dave Rodgman904c5892023-06-28 17:36:02 +01004177 msg "build: TF-M config, gcc native build"
4178 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004179 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 +01004180}
4181
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004182# Test that the given .o file builds with all (valid) combinations of the given options.
4183#
4184# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4185#
4186# The validator function is the name of a function to validate the combination of options.
4187# It may be "" if all combinations are valid.
4188# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004189# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004190build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004191 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004192 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004193 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004194 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004195 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004196
Dave Rodgman42436102023-10-03 15:47:05 +01004197 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004198 for opt in "${options[@]}"; do
4199 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004200 done
4201
4202 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004203 cd $(dirname ${file})
4204 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004205
Dave Rodgman920343a2023-10-01 18:41:09 +01004206 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004207 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 +01004208
Dave Rodgman42436102023-10-03 15:47:05 +01004209 # Extract the command generated by the Makefile to build the target file.
4210 # This ensures that we have any include paths, macro definitions, etc
4211 # that may be applied by make.
4212 # 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 +01004213 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004214
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004215 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004216 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004217
Dave Rodgman28e38d82023-10-04 11:50:30 +01004218 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004219 source_file=${file%.o}.c
4220
4221 targets=0
4222 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004223
Dave Rodgman28e38d82023-10-04 11:50:30 +01004224 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004225 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004226 # each bit of $i is used to determine if options[i] will be set or not
4227 target="t"
4228 clang_args=""
4229 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004230 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004231 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004232 clang_args="${clang_args} ${opt}"
4233 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004234 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004235 done
4236
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004237 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004238 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004239 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004240 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004241
Dave Rodgman28e38d82023-10-04 11:50:30 +01004242 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004243 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004244 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004245 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004246
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004247 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004248
Dave Rodgman920343a2023-10-01 18:41:09 +01004249 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004250 make -s -f ${makefile} build_test_config_combos
4251 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004252
4253 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004254 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004255}
4256
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004257validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004258 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4259 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004260 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004261 fi
4262 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4263 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004264 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004265 fi
4266 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004267 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004268}
4269
4270component_build_aes_variations() {
4271 # 18s - around 90ms per clang invocation on M1 Pro
4272 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004273 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004274 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004275
Yanray Wangbc29aef2023-11-06 11:08:17 +08004276 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004277 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004278
Dave Rodgman42436102023-10-03 15:47:05 +01004279 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004280 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4281 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4282 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4283 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004284
4285 cd "$MBEDTLS_ROOT_DIR"
4286 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4287
Yanray Wang42be1ba2023-11-23 14:28:47 +08004288 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004289 # manually set or unset those configurations to check
4290 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004291 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4292 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4293 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4294 scripts/config.py unset MBEDTLS_DES_C
4295 scripts/config.py unset MBEDTLS_NIST_KW_C
4296 build_test_config_combos library/aes.o validate_aes_config_variations \
4297 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4298 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4299 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4300 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004301}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004302
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004303component_test_no_platform () {
4304 # Full configuration build, without platform support, file IO and net sockets.
4305 # This should catch missing mbedtls_printf definitions, and by disabling file
4306 # IO, it should catch missing '#include <stdio.h>'
4307 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004308 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004309 scripts/config.py unset MBEDTLS_PLATFORM_C
4310 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004311 scripts/config.py unset MBEDTLS_FS_IO
4312 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004313 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004314 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004315 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004316 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004317 # to re-enable platform integration features otherwise disabled in C99 builds
4318 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004319 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004320}
Gilles Peskine7c652162017-12-11 00:01:40 +01004321
4322component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004323 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004324 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4325 scripts/config.py full
4326 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004327 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4328 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4329 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4330 make
4331}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004332
Gilles Peskine8f073122018-11-27 15:58:47 +01004333component_build_no_ssl_srv () {
4334 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004335 scripts/config.py full
4336 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004337 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004338}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004339
Gilles Peskine8f073122018-11-27 15:58:47 +01004340component_build_no_ssl_cli () {
4341 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004342 scripts/config.py full
4343 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004344 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004345}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004346
Gilles Peskine8f073122018-11-27 15:58:47 +01004347component_build_no_sockets () {
4348 # Note, C99 compliance can also be tested with the sockets support disabled,
4349 # as that requires a POSIX platform (which isn't the same as C99).
4350 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004351 scripts/config.py full
4352 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4353 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4354 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4355}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004356
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004357component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004358 msg "build: default config with memory buffer allocator and backtrace enabled"
4359 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4360 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4361 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004362 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004363 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004364 make
4365
4366 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4367 make test
4368}
4369
4370component_test_memory_buffer_allocator () {
4371 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004372 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4373 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004374 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004375 make
4376
4377 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4378 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004379
4380 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4381 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004382 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004383}
4384
Gilles Peskine8f073122018-11-27 15:58:47 +01004385component_test_no_max_fragment_length () {
4386 # Run max fragment length tests with MFL disabled
4387 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004388 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004389 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004390 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004391
Gilles Peskine8f073122018-11-27 15:58:47 +01004392 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004393 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004394}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004395
Hanno Becker545ced42019-02-19 11:10:48 +00004396component_test_asan_remove_peer_certificate () {
4397 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004398 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004399 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004400 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004401 make
4402
4403 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4404 make test
4405
4406 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004407 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004408
4409 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004410 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004411
4412 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004413 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004414}
4415
Gilles Peskine8f073122018-11-27 15:58:47 +01004416component_test_no_max_fragment_length_small_ssl_out_content_len () {
4417 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004418 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4419 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4420 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004421 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004422 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004423
Gilles Peskine8f073122018-11-27 15:58:47 +01004424 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004425 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004426
4427 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004428 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004429}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004430
Darryl Greenaad82f92019-12-02 10:53:11 +00004431component_test_variable_ssl_in_out_buffer_len () {
4432 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4433 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004434 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004435 make
4436
4437 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4438 make test
4439
4440 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004441 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004442
4443 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004444 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004445}
4446
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004447component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004448 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004449 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004450
Dave Rodgman17127e92023-12-14 16:42:48 +00004451 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004452 make
4453
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004454 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004455 make test
4456
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004457 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004458 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004459
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004460 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004461 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004462}
4463
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004464component_test_ssl_alloc_buffer_and_mfl () {
4465 msg "build: default config with memory buffer allocator and MFL extension"
4466 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4467 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4468 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4469 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4470 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004471 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004472 make
4473
4474 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4475 make test
4476
4477 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 +02004478 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004479}
4480
Gilles Peskine636c26a2020-03-04 20:46:15 +01004481component_test_when_no_ciphersuites_have_mac () {
4482 msg "build: when no ciphersuites have MAC"
4483 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004484 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004485 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004486 make
4487
4488 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4489 make test
4490
4491 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004492 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004493}
4494
Raoul Strackxa4e86142020-06-15 17:03:13 +02004495component_test_no_date_time () {
4496 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4497 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004498 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004499 make
4500
4501 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4502 make test
4503}
4504
Gilles Peskine8f073122018-11-27 15:58:47 +01004505component_test_platform_calloc_macro () {
4506 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004507 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4508 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4509 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004510 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004511 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004512
Gilles Peskine8f073122018-11-27 15:58:47 +01004513 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4514 make test
4515}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004516
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004517component_test_malloc_0_null () {
4518 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004519 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004520 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 +02004521
4522 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4523 make test
4524
4525 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4526 # Just the calloc selftest. "make test" ran the others as part of the
4527 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004528 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004529
4530 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4531 # Run a subset of the tests. The choice is a balance between coverage
4532 # and time (including time indirectly wasted due to flaky tests).
4533 # The current choice is to skip tests whose description includes
4534 # "proxy", which is an approximation of skipping tests that use the
4535 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004536 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004537}
4538
Dave Rodgman6a08b682023-06-19 11:51:33 +01004539support_test_aesni() {
4540 # Check that gcc targets x86_64 (we can build AESNI), and check for
4541 # AESNI support on the host (we can run AESNI).
4542 #
4543 # The name of this function is possibly slightly misleading, but needs to align
4544 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004545 #
4546 # In principle 32-bit x86 can support AESNI, but our implementation does not
4547 # support 32-bit x86, so we check for x86-64.
4548 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004549 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4550 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004551 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004552}
4553
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004554component_test_aesni () { # ~ 60s
4555 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4556 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4557 #
4558 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4559 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4560 # exercise the plain C impl).
4561
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004562 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004563 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004564 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004565 scripts/config.py set MBEDTLS_HAVE_ASM
4566
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004567 # test the intrinsics implementation
4568 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004569 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004570 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004571 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004572 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004573
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004574 # test the asm implementation
4575 msg "AES tests, test assembly"
4576 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004577 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004578 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004579 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004580
4581 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004582 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004583 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004584 msg "AES tests, plain C"
4585 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004586 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004587 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004588 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004589 not grep -q "AES note: using AESNI" ./programs/test/selftest
4590 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004591
4592 # test the intrinsics implementation
4593 scripts/config.py set MBEDTLS_AESNI_C
4594 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4595 msg "AES tests, test AESNI only"
4596 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004597 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004598 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4599 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004600 grep -q "AES note: using AESNI" ./programs/test/selftest
4601 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004602}
4603
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004604component_test_sha3_variations() {
4605 msg "sha3 loop unroll variations"
4606
4607 # define minimal config sufficient to test SHA3
4608 cat > include/mbedtls/mbedtls_config.h << END
4609 #define MBEDTLS_SELF_TEST
4610 #define MBEDTLS_SHA3_C
4611END
4612
4613 msg "all loops unrolled"
4614 make clean
4615 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"
4616 ./tests/test_suite_shax
4617
4618 msg "all loops rolled up"
4619 make clean
4620 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"
4621 ./tests/test_suite_shax
4622}
4623
Jerry Yub6d39c22023-08-16 15:11:48 +08004624support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004625 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004626}
4627
4628component_test_aesni_m32 () { # ~ 60s
4629 # This tests are duplicated from component_test_aesni for i386 target
4630 #
4631 # AESNI intrinsic code supports i386 and assembly code does not support it.
4632
4633 msg "build: default config with different AES implementations"
4634 scripts/config.py set MBEDTLS_AESNI_C
4635 scripts/config.py set MBEDTLS_PADLOCK_C
4636 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4637 scripts/config.py set MBEDTLS_HAVE_ASM
4638
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004639 # test the intrinsics implementation with gcc
4640 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004641 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004642 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004643 # check that we built intrinsics - this should be used by default when supported by the compiler
4644 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4645 grep -q "AES note: using AESNI" ./programs/test/selftest
4646 grep -q "AES note: built-in implementation." ./programs/test/selftest
4647 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4648 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4649
4650 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004651 scripts/config.py unset MBEDTLS_PADLOCK_C
4652 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4653 msg "AES tests, test AESNI only"
4654 make clean
4655 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4656 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4657 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4658 grep -q "AES note: using AESNI" ./programs/test/selftest
4659 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4660 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4661 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4662}
4663
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004664support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004665 # clang >= 4 is required to build with target attributes
4666 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004667}
4668
4669component_test_aesni_m32_clang() {
4670
4671 scripts/config.py set MBEDTLS_AESNI_C
4672 scripts/config.py set MBEDTLS_PADLOCK_C
4673 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4674 scripts/config.py set MBEDTLS_HAVE_ASM
4675
4676 # test the intrinsics implementation with clang
4677 msg "AES tests, test intrinsics (clang)"
4678 make clean
4679 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4680 # check that we built intrinsics - this should be used by default when supported by the compiler
4681 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4682 grep -q "AES note: using AESNI" ./programs/test/selftest
4683 grep -q "AES note: built-in implementation." ./programs/test/selftest
4684 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4685 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4686}
4687
Jerry Yu193cbc02023-08-03 17:06:29 +08004688# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4689component_build_aes_aesce_armcc () {
4690 msg "Build: AESCE test on arm64 platform without plain C."
4691 scripts/config.py baremetal
4692
4693 # armc[56] don't support SHA-512 intrinsics
4694 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4695
4696 # Stop armclang warning about feature detection for A64_CRYPTO.
4697 # With this enabled, the library does build correctly under armclang,
4698 # but in baremetal builds (as tested here), feature detection is
4699 # unavailable, and the user is notified via a #warning. So enabling
4700 # this feature would prevent us from building with -Werror on
4701 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004702 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004703 scripts/config.py set MBEDTLS_HAVE_ASM
4704
4705 msg "AESCE, build with default configuration."
4706 scripts/config.py set MBEDTLS_AESCE_C
4707 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4708 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4709
4710 msg "AESCE, build AESCE only"
4711 scripts/config.py set MBEDTLS_AESCE_C
4712 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4713 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4714}
4715
Dave Rodgman0c584032023-10-08 12:26:54 +01004716support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004717 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004718 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004719}
4720
4721component_build_aes_armce () {
4722 # Test variations of AES with Armv8 crypto extensions
4723 scripts/config.py set MBEDTLS_AESCE_C
4724 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4725
4726 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004727 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004728
4729 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4730 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4731
4732 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4733 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4734
Dave Rodgman5e419372023-10-23 15:30:20 +01004735 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004736
Dave Rodgman5e419372023-10-23 15:30:20 +01004737 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4738 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004739
Dave Rodgman5e419372023-10-23 15:30:20 +01004740 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4741 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004742
Dave Rodgman5e419372023-10-23 15:30:20 +01004743 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4744 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004745
4746 # test for presence of AES instructions
4747 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4748 msg "clang, test A32 crypto instructions built"
4749 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4750 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4751 msg "clang, test T32 crypto instructions built"
4752 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4753 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4754 msg "clang, test aarch64 crypto instructions built"
4755 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4756 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4757
4758 # test for absence of AES instructions
4759 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4760 scripts/config.py unset MBEDTLS_AESCE_C
4761 msg "clang, test A32 crypto instructions not built"
4762 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4763 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4764 msg "clang, test T32 crypto instructions not built"
4765 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4766 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4767 msg "clang, test aarch64 crypto instructions not built"
4768 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4769 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004770}
4771
Dave Rodgman9ed18532023-10-05 00:06:47 +01004772support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004773 # clang >= 4 is required to build with SHA extensions
4774 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004775}
4776
Dave Rodgmand9e80832023-10-04 17:17:46 +01004777component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004778 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004779
4780
4781 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004782 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004783 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4784 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4785 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4786 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4787 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004788
Dave Rodgmand9e80832023-10-04 17:17:46 +01004789
Dave Rodgman94a634d2023-10-10 12:59:29 +01004790 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004791 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004792 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4793 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4794 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004795
Dave Rodgman5b89c552023-10-10 14:59:02 +01004796 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004797 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4798 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4799 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004800
Dave Rodgmancd654002023-10-05 09:40:07 +01004801
Dave Rodgman94a634d2023-10-10 12:59:29 +01004802 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004803 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004804 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4805 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4806 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4807 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4808 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004809
Dave Rodgmancd654002023-10-05 09:40:07 +01004810
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004811 # examine the disassembly for presence of SHA instructions
4812 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4813 scripts/config.py set ${opt}
4814 msg "${opt} clang, test A32 crypto instructions built"
4815 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4816 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4817
4818 msg "${opt} clang, test T32 crypto instructions built"
4819 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4820 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4821
4822 msg "${opt} clang, test aarch64 crypto instructions built"
4823 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4824 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4825 scripts/config.py unset ${opt}
4826 done
4827
4828
4829 # examine the disassembly for absence of SHA instructions
4830 msg "clang, test A32 crypto instructions not built"
4831 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4832 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4833
4834 msg "clang, test T32 crypto instructions not built"
4835 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4836 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4837
4838 msg "clang, test aarch64 crypto instructions not built"
4839 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4840 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004841}
4842
Jerry Yuc935aa62023-08-03 17:08:27 +08004843# For timebeing, no VIA Padlock platform available.
4844component_build_aes_via_padlock () {
4845
4846 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004847 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004848 scripts/config.py set MBEDTLS_PADLOCK_C
4849 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004850 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004851 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004852
4853}
4854
4855support_build_aes_via_padlock_only () {
4856 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4857 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4858 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4859}
4860
Jerry Yu193cbc02023-08-03 17:06:29 +08004861support_build_aes_aesce_armcc () {
4862 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004863}
4864
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004865component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004866 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004867 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004868 scripts/config.py unset MBEDTLS_PADLOCK_C
4869
Dave Rodgmand8d64512023-12-19 12:20:21 +00004870 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004871
4872 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4873 make test
4874}
4875
4876component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4877 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4878 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004879 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4880 scripts/config.py unset MBEDTLS_PADLOCK_C
4881
Hanno Becker83ebf782017-07-07 12:29:15 +01004882 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004883
4884 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004885 make test
4886}
Gilles Peskine8f073122018-11-27 15:58:47 +01004887
Hanno Becker83ebf782017-07-07 12:29:15 +01004888component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004889 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4890 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4891 scripts/config.py unset MBEDTLS_PADLOCK_C
4892 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004893 scripts/config.py unset MBEDTLS_AESCE_C
4894
Dave Rodgmand8d64512023-12-19 12:20:21 +00004895 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004896
4897 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004898 make test
4899
4900 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4901 programs/test/selftest
4902}
4903
Matthias Schulz0767fda2024-02-07 10:46:28 +01004904component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004905 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4906 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004907 scripts/config.py unset MBEDTLS_PADLOCK_C
4908 scripts/config.py unset MBEDTLS_AESNI_C
4909 scripts/config.py unset MBEDTLS_AESCE_C
4910
4911 make CFLAGS='-O2 -Werror -Wall -Wextra'
4912
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004913 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004914 make test
4915}
4916
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004917component_test_aes_fewer_tables () {
4918 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004919 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004920 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004921
Gilles Peskine7c652162017-12-11 00:01:40 +01004922 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004923 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004924}
4925
4926component_test_aes_rom_tables () {
4927 msg "build: default config with AES_ROM_TABLES enabled"
4928 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004929 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004930
4931 msg "test: AES_ROM_TABLES"
4932 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004933}
4934
Gilles Peskine14c3c062018-01-29 21:25:12 +01004935component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004936 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4937 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4938 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004939 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004940
Gilles Peskine8f073122018-11-27 15:58:47 +01004941 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4942 make test
4943}
4944
Yanray Wang49cd4b52023-11-10 11:58:37 +08004945# helper for common_block_cipher_no_decrypt() which:
4946# - enable/disable the list of config options passed from -s/-u respectively.
4947# - build
4948# - test for tests_suite_xxx
4949# - selftest
4950#
4951# Usage: helper_block_cipher_no_decrypt_build_test
4952# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4953# Options: -s set_opts the list of config options to enable
4954# -u unset_opts the list of config options to disable
4955# -c cflags the list of options passed to CFLAGS
4956# -l ldflags the list of options passed to LDFLAGS
4957helper_block_cipher_no_decrypt_build_test () {
4958 while [ $# -gt 0 ]; do
4959 case "$1" in
4960 -s)
4961 shift; local set_opts="$1";;
4962 -u)
4963 shift; local unset_opts="$1";;
4964 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004965 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004966 -l)
4967 shift; local ldflags="$1";;
4968 esac
4969 shift
4970 done
4971 set_opts="${set_opts:-}"
4972 unset_opts="${unset_opts:-}"
4973 cflags="${cflags:-}"
4974 ldflags="${ldflags:-}"
4975
Yanray Wangb2d6e522023-11-13 16:57:47 +08004976 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4977 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004978
4979 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4980 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004981 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004982
4983 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4984 not grep mbedtls_aes_setkey_dec library/aes.o
4985 not grep mbedtls_aria_setkey_dec library/aria.o
4986 not grep mbedtls_camellia_setkey_dec library/camellia.o
4987 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4988 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004989 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4990 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004991
4992 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4993 make test
4994
4995 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4996 programs/test/selftest
4997}
4998
4999# This is a common configuration function used in:
5000# - component_test_block_cipher_no_decrypt_aesni_legacy()
5001# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5002# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5003# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5004# on x86.
5005common_block_cipher_no_decrypt () {
5006 # test AESNI intrinsics
5007 helper_block_cipher_no_decrypt_build_test \
5008 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005009 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005010
5011 # test AESNI assembly
5012 helper_block_cipher_no_decrypt_build_test \
5013 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005014 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005015
5016 # test AES C implementation
5017 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005018 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005019
5020 # test AESNI intrinsics for i386 target
5021 helper_block_cipher_no_decrypt_build_test \
5022 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005023 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005024 -l "-m32"
5025}
5026
Yanray Wang3ae11992023-11-13 17:32:09 +08005027# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5028# usage: 0: no PSA crypto configuration
5029# 1: use PSA crypto configuration
5030config_block_cipher_no_decrypt () {
5031 use_psa=$1
5032
Yanray Wang66111392023-10-31 18:54:54 +08005033 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005034 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5035 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005036 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005037 scripts/config.py unset MBEDTLS_NIST_KW_C
5038
Yanray Wang3ae11992023-11-13 17:32:09 +08005039 if [ "$use_psa" -eq 1 ]; then
5040 # Enable support for cryptographic mechanisms through the PSA API.
5041 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5042 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5043 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5044 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5045 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5046 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5047 fi
5048}
5049
5050component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005051 # This consistently causes an llvm crash on clang 3.8, so use gcc
5052 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005053 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005054 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005055}
5056
Yanray Wangf1496402023-11-01 18:55:13 +08005057component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005058 # This consistently causes an llvm crash on clang 3.8, so use gcc
5059 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005060 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005061 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005062}
5063
Yanray Wang66111392023-10-31 18:54:54 +08005064support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005065 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005066}
5067
Yanray Wang66111392023-10-31 18:54:54 +08005068component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005069 scripts/config.py baremetal
5070
5071 # armc[56] don't support SHA-512 intrinsics
5072 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5073
5074 # Stop armclang warning about feature detection for A64_CRYPTO.
5075 # With this enabled, the library does build correctly under armclang,
5076 # but in baremetal builds (as tested here), feature detection is
5077 # unavailable, and the user is notified via a #warning. So enabling
5078 # this feature would prevent us from building with -Werror on
5079 # armclang. Tracked in #7198.
5080 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5081 scripts/config.py set MBEDTLS_HAVE_ASM
5082
Yanray Wang3ae11992023-11-13 17:32:09 +08005083 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005084
5085 # test AESCE baremetal build
5086 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005087 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005088 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005089
Yanray Wangef1b04d2023-09-08 11:09:26 +08005090 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5091 not grep mbedtls_aes_setkey_dec library/aes.o
5092 not grep mbedtls_aria_setkey_dec library/aria.o
5093 not grep mbedtls_camellia_setkey_dec library/camellia.o
5094 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5095 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005096 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005097 not grep mbedtls_aesce_inverse_key library/aesce.o
5098 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005099}
5100
Gilles Peskine592f5912019-10-07 18:49:32 +02005101component_test_ctr_drbg_aes_256_sha_256 () {
5102 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5103 scripts/config.py full
5104 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5105 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005106 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005107 make
5108
5109 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5110 make test
5111}
5112
5113component_test_ctr_drbg_aes_128_sha_512 () {
5114 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005115 scripts/config.py full
5116 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5117 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005118 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005119 make
5120
5121 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5122 make test
5123}
5124
5125component_test_ctr_drbg_aes_128_sha_256 () {
5126 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005127 scripts/config.py full
5128 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5129 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5130 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005131 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005132 make
5133
5134 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5135 make test
5136}
5137
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005138component_test_se_default () {
5139 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005140 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005141 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005142
5143 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5144 make test
5145}
5146
Steven Cooremand57203d2020-07-16 20:28:59 +02005147component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005148 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005149 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005150 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005151 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5152 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005153 loc_cflags="${loc_cflags} -I../tests/include -O2"
5154
Gilles Peskine21570cf2023-12-22 11:49:50 +01005155 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005156
Gilles Peskine1997f302023-07-26 18:45:20 +02005157 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005158 make test
5159}
5160
Gilles Peskine8f073122018-11-27 15:58:47 +01005161component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005162 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005163 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005164 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005165 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005166}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005167
Gilles Peskinecf740502019-07-03 20:43:05 +02005168component_test_cmake_shared () {
5169 msg "build/test: cmake shared" # ~ 2min
5170 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5171 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005172 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005173 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005174 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005175}
5176
Gilles Peskineec10bf12019-09-20 19:56:06 +02005177test_build_opt () {
5178 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005179 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005180 for opt in "$@"; do
5181 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005182 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005183 # We're confident enough in compilers to not run _all_ the tests,
5184 # but at least run the unit tests. In particular, runs with
5185 # optimizations use inline assembly whereas runs with -O0
5186 # skip inline assembly.
5187 make test # ~30s
5188 make clean
5189 done
5190}
5191
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005192# For FreeBSD we invoke the function by name so this condition is added
5193# to disable the existing test_clang_opt function for linux.
5194if [[ $(uname) != "Linux" ]]; then
5195 component_test_clang_opt () {
5196 scripts/config.py full
5197 test_build_opt 'full config' clang -O0 -Os -O2
5198 }
5199fi
5200
5201component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005202 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005203 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005204}
5205support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005206 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005207}
5208
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005209component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005210 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005211 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005212}
5213support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005214 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005215}
5216
5217component_test_gcc_latest_opt () {
5218 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005219 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005220}
5221support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005222 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005223}
5224
5225component_test_gcc_earliest_opt () {
5226 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005227 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005228}
5229support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005230 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005231}
5232
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005233component_build_mbedtls_config_file () {
5234 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005235 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005236 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005237 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005238 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005239 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5240 make clean
5241
5242 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5243 # In the user config, disable one feature (for simplicity, pick a feature
5244 # that nothing else depends on).
5245 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005246 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005247 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5248
5249 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005250}
5251
Gilles Peskine7d904e72022-04-07 21:59:14 +02005252component_build_psa_config_file () {
5253 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5254 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5255 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5256 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5257 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005258 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005259 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5260 make clean
5261
5262 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005263 # In the user config, disable one feature and its dependencies, which will
5264 # reflect on the mbedtls configuration so we can query it with
5265 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005266 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005267 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005268 scripts/config.py unset MBEDTLS_CMAC_C
5269 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5270 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5271
5272 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005273}
5274
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005275component_build_psa_alt_headers () {
5276 msg "build: make with PSA alt headers" # ~20s
5277
5278 # Generate alternative versions of the substitutable headers with the
5279 # same content except different include guards.
5280 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5281
5282 # Build the library and some programs.
5283 # Don't build the fuzzers to avoid having to go through hoops to set
5284 # a correct include path for programs/fuzz/Makefile.
5285 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
5286 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\"'"
5287
5288 # Check that we're getting the alternative include guards and not the
5289 # original include guards.
5290 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5291 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5292 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5293 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5294}
5295
Dave Rodgman852de3c2023-12-14 14:46:45 +00005296component_test_m32_no_asm () {
5297 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005298 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005299 #
5300 # Note that we require gcc, because clang Asan builds fail to link for
5301 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005302 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005303 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005304 scripts/config.py unset MBEDTLS_HAVE_ASM
5305 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005306 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005307 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005308
Dave Rodgman852de3c2023-12-14 14:46:45 +00005309 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005310 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005311}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005312support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005313 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005314 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005315 *) false;;
5316 esac
5317}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005318
Gilles Peskineff0aee02021-10-05 09:36:03 +02005319component_test_m32_o2 () {
5320 # Build with optimization, to use the i386 specific inline assembly
5321 # and go faster for tests.
5322 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005323 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005324 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005325 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005326
Gilles Peskineff0aee02021-10-05 09:36:03 +02005327 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005328 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005329
Gilles Peskineff0aee02021-10-05 09:36:03 +02005330 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005331 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005332}
Gilles Peskinecf522222021-10-07 19:25:29 +02005333support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005334 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005335}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005336
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005337component_test_m32_everest () {
5338 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005339 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005340 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005341 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005342
5343 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5344 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005345
5346 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005347 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005348
5349 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5350 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005351 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005352}
5353support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005354 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005355}
5356
Gilles Peskine8f073122018-11-27 15:58:47 +01005357component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005358 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005359 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005360 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005361
5362 msg "test: 64-bit ILP32, make, gcc"
5363 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005364}
Gilles Peskine878cf602019-01-06 20:50:38 +00005365support_test_mx32 () {
5366 case $(uname -m) in
5367 amd64|x86_64) true;;
5368 *) false;;
5369 esac
5370}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005371
Peter Kolbus60c6da22018-12-27 06:59:04 -06005372component_test_min_mpi_window_size () {
5373 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005374 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005375 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005376 make
5377
5378 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5379 make test
5380}
5381
Gilles Peskine8f073122018-11-27 15:58:47 +01005382component_test_have_int32 () {
5383 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005384 scripts/config.py unset MBEDTLS_HAVE_ASM
5385 scripts/config.py unset MBEDTLS_AESNI_C
5386 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005387 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005388 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005389
Gilles Peskine8f073122018-11-27 15:58:47 +01005390 msg "test: gcc, force 32-bit bignum limbs"
5391 make test
5392}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005393
Gilles Peskine8f073122018-11-27 15:58:47 +01005394component_test_have_int64 () {
5395 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005396 scripts/config.py unset MBEDTLS_HAVE_ASM
5397 scripts/config.py unset MBEDTLS_AESNI_C
5398 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005399 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005400 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005401
Gilles Peskine8f073122018-11-27 15:58:47 +01005402 msg "test: gcc, force 64-bit bignum limbs"
5403 make test
5404}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005405
Gabor Mezeie256cc12023-07-26 17:28:48 +02005406component_test_have_int32_cmake_new_bignum () {
5407 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5408 scripts/config.py unset MBEDTLS_HAVE_ASM
5409 scripts/config.py unset MBEDTLS_AESNI_C
5410 scripts/config.py unset MBEDTLS_PADLOCK_C
5411 scripts/config.py unset MBEDTLS_AESCE_C
5412 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005413 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005414 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005415
5416 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5417 make test
5418}
5419
Gilles Peskine8f073122018-11-27 15:58:47 +01005420component_test_no_udbl_division () {
5421 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005422 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005423 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005424 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005425
Gilles Peskine8f073122018-11-27 15:58:47 +01005426 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5427 make test
5428}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005429
Gilles Peskine8f073122018-11-27 15:58:47 +01005430component_test_no_64bit_multiplication () {
5431 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005432 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005433 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005434 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005435
Gilles Peskine8f073122018-11-27 15:58:47 +01005436 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5437 make test
5438}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005439
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005440component_test_no_strings () {
5441 msg "build: no strings" # ~10s
5442 scripts/config.py full
5443 # Disable options that activate a large amount of string constants.
5444 scripts/config.py unset MBEDTLS_DEBUG_C
5445 scripts/config.py unset MBEDTLS_ERROR_C
5446 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5447 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005448 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005449
5450 msg "test: no strings" # ~ 10s
5451 make test
5452}
5453
Hanno Beckerc5722d12020-10-09 11:10:42 +01005454component_test_no_x509_info () {
5455 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5456 scripts/config.pl full
5457 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5458 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005459 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005460
5461 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5462 make test
5463
5464 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005465 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005466}
5467
Gilles Peskine8f073122018-11-27 15:58:47 +01005468component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005469 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005470 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005471 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 +02005472
Gilles Peskinee36fe812021-09-01 20:00:33 +02005473 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005474 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005475}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005476
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005477component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005478 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005479 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005480 # Build for a target platform that's close to what Debian uses
5481 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005482 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005483 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005484 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005485 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'
5486
Gilles Peskinee36fe812021-09-01 20:00:33 +02005487 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005488 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005489}
5490support_build_arm_linux_gnueabi_gcc_arm5vte () {
5491 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5492}
5493
5494component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005495 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005496 scripts/config.py baremetal
5497 # This is an imperfect substitute for
5498 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005499 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005500 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 +02005501
Gilles Peskinee36fe812021-09-01 20:00:33 +02005502 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005503 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005504}
5505
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005506component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005507 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5508 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005509 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 +02005510
Gilles Peskinee36fe812021-09-01 20:00:33 +02005511 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005512 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005513 for lib in library/*.a; do
5514 echo "$lib:"
5515 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5516 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005517}
5518
Gilles Peskine8f073122018-11-27 15:58:47 +01005519component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005520 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005521 scripts/config.py baremetal
5522 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005523 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 +01005524 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005525 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005526}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005527
Gilles Peskine8f073122018-11-27 15:58:47 +01005528component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005529 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005530 scripts/config.py baremetal
5531 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005532 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 +01005533 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005534 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005535}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005536
Dave Rodgman8c315f22023-06-02 10:26:24 -04005537component_build_arm_clang_thumb () {
5538 # ~ 30s
5539
5540 scripts/config.py baremetal
5541
5542 msg "build: clang thumb 2, make"
5543 make clean
5544 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5545
5546 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5547 msg "build: clang thumb 1 -O0, make"
5548 make clean
5549 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5550
5551 msg "build: clang thumb 1 -Os, make"
5552 make clean
5553 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5554}
5555
Gilles Peskine8f073122018-11-27 15:58:47 +01005556component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005557 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005558 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005559 # armc[56] don't support SHA-512 intrinsics
5560 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005561
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005562 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5563 scripts/config.py unset MBEDTLS_AESCE_C
5564
Dave Rodgman0fddf822023-03-02 15:32:12 +00005565 # Stop armclang warning about feature detection for A64_CRYPTO.
5566 # With this enabled, the library does build correctly under armclang,
5567 # but in baremetal builds (as tested here), feature detection is
5568 # unavailable, and the user is notified via a #warning. So enabling
5569 # this feature would prevent us from building with -Werror on
5570 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005571 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005572
Hanno Beckerf0762e92022-07-15 12:08:19 +01005573 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005574
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005575 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005576
5577 msg "size: ARM Compiler 5"
5578 "$ARMC5_FROMELF" -z library/*.o
5579
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005580 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005581
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005582 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005583 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005584
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005585 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005586 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5587
5588 # ARM Compiler 6 - Target ARMv7-M+DSP
5589 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005590
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005591 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005592 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005593
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005594 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005595 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005596
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005597 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5598 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5599
Dave Rodgman99318e62023-05-24 12:27:42 +01005600 # ARM Compiler 6 - Target Cortex-M0
5601 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005602
5603 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5604 #
5605 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5606 # that we have in our CI
5607 scripts/config.py set MBEDTLS_AESCE_C
5608 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005609}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005610
Pengyu Lvdf070032023-02-24 16:03:31 +08005611support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005612 armc5_cc="$ARMC5_BIN_DIR/armcc"
5613 armc6_cc="$ARMC6_BIN_DIR/armclang"
5614 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005615}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005616
Ronald Crond2cb7f42024-03-18 12:49:18 +01005617component_test_tls12_only () {
5618 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5619 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5620 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5621 make
5622
5623 msg "test: main suites (inc. selftests) (ASan build)"
5624 make test
5625
5626 msg "test: ssl-opt.sh (ASan build)"
5627 tests/ssl-opt.sh
5628
5629 msg "test: compat.sh (ASan build)"
5630 tests/compat.sh
5631}
5632
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005633component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005634 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005635 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005636 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005637 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5638
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005639 msg "test: TLS 1.3 only, all key exchange modes enabled"
5640 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005641
Ronald Cronc3f43b62022-10-17 17:35:32 +02005642 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5643 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005644}
5645
Ronald Cronc3f43b62022-10-17 17:35:32 +02005646component_test_tls13_only_psk () {
5647 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5648 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5649 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5650 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005651 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005652 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5653 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5654 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5655 scripts/config.py unset MBEDTLS_ECDSA_C
5656 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005657 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005658 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005659 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5660
Ronald Cronc3f43b62022-10-17 17:35:32 +02005661 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5662 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005663
Ronald Cronc3f43b62022-10-17 17:35:32 +02005664 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5665 tests/ssl-opt.sh
5666}
5667
5668component_test_tls13_only_ephemeral () {
5669 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5670 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5671 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005672 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005673 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5674
5675 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5676 cd tests; ./test_suite_ssl; cd ..
5677
5678 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5679 tests/ssl-opt.sh
5680}
5681
Przemek Stekiela01c2422023-06-13 10:46:48 +02005682component_test_tls13_only_ephemeral_ffdh () {
5683 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5684 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5685 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5686 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005687 scripts/config.py unset MBEDTLS_ECDH_C
5688
Przemek Stekiela01c2422023-06-13 10:46:48 +02005689 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5690
5691 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5692 cd tests; ./test_suite_ssl; cd ..
5693
5694 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5695 tests/ssl-opt.sh
5696}
5697
Ronald Cronc3f43b62022-10-17 17:35:32 +02005698component_test_tls13_only_psk_ephemeral () {
5699 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5700 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5701 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5702 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5703 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5704 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5705 scripts/config.py unset MBEDTLS_ECDSA_C
5706 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005707 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005708 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005709 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5710
5711 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5712 cd tests; ./test_suite_ssl; cd ..
5713
5714 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5715 tests/ssl-opt.sh
5716}
5717
Przemek Stekiela01c2422023-06-13 10:46:48 +02005718component_test_tls13_only_psk_ephemeral_ffdh () {
5719 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5720 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5721 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5722 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5723 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5724 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5725 scripts/config.py unset MBEDTLS_ECDSA_C
5726 scripts/config.py unset MBEDTLS_PKCS1_V21
5727 scripts/config.py unset MBEDTLS_PKCS7_C
5728 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005729 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005730 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5731
5732 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5733 cd tests; ./test_suite_ssl; cd ..
5734
5735 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5736 tests/ssl-opt.sh
5737}
5738
Ronald Cronc3f43b62022-10-17 17:35:32 +02005739component_test_tls13_only_psk_all () {
5740 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5741 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5742 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5743 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5744 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5745 scripts/config.py unset MBEDTLS_ECDSA_C
5746 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005747 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005748 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005749 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5750
5751 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5752 cd tests; ./test_suite_ssl; cd ..
5753
5754 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5755 tests/ssl-opt.sh
5756}
5757
5758component_test_tls13_only_ephemeral_all () {
5759 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5760 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005761 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005762 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5763
5764 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5765 cd tests; ./test_suite_ssl; cd ..
5766
5767 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5768 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005769}
5770
Ronald Cron46ac0652024-03-18 12:39:04 +01005771component_test_tls13_no_padding () {
5772 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005773 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005774 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005775 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005776 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005777 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005778 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005779 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005780 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005781}
5782
Ronald Cron6f135e12021-12-08 16:57:54 +01005783component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005784 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005785 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005786 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005787 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005788 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005789 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005790 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005791 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005792 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005793}
5794
Ronald Crondd96c0a2024-04-02 12:34:24 +02005795component_test_full_minus_session_tickets() {
5796 msg "build: full config without session tickets"
5797 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005798 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005799 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005800 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5801 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005802 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005803 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005804 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005805 tests/ssl-opt.sh
5806}
5807
Gilles Peskine8f073122018-11-27 15:58:47 +01005808component_build_mingw () {
5809 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005810 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 +00005811
Gilles Peskine8f073122018-11-27 15:58:47 +01005812 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005813 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 +01005814 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005815
Gilles Peskine8f073122018-11-27 15:58:47 +01005816 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005817 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
5818 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 +01005819 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005820
Pengyu Lv158eead2023-10-19 11:27:05 +08005821 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005822 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005823 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 +01005824 make WINDOWS_BUILD=1 clean
5825}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005826support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005827 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5828 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005829 *) true;;
5830 esac
5831}
Simon Butcher91aef332016-11-17 09:20:50 +00005832
Gilles Peskine8f073122018-11-27 15:58:47 +01005833component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005834 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005835 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005836 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5837 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005838
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005839 msg "test: main suites (MSan)" # ~ 10s
5840 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005841
Gilles Peskine6848d172023-11-02 19:58:03 +01005842 msg "test: metatests (MSan)"
5843 tests/scripts/run-metatests.sh any msan
5844
Gilles Peskine82b27272019-06-14 18:27:03 +02005845 msg "program demos (MSan)" # ~20s
5846 tests/scripts/run_demos.py
5847
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005848 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005849 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005850
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005851 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005852
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005853 if [ "$MEMORY" -gt 0 ]; then
5854 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005855 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005856 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005857}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005858
Bence Szépkúti0354d042023-12-06 16:14:37 +01005859component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005860 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005861 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005862 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5863 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005864
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005865 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005866 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005867
Gilles Peskine636c26a2020-03-04 20:46:15 +01005868 # Optional parts (slow; currently broken on OS X because programs don't
5869 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005870 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005871 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005872 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005873 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005874 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005875
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005876 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005877 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005878 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005879 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005880
5881 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005882 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005883 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005884 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005885}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005886
Bence Szépkúti0354d042023-12-06 16:14:37 +01005887component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005888 msg "build: Release, full (clang)"
5889 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5890 scripts/config.py full
5891 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5892 make
5893
5894 msg "test: main suites, Valgrind (full config)"
5895 make memcheck
5896}
5897
Paul Elliott62dc3922021-11-25 17:29:40 +00005898support_test_cmake_out_of_source () {
5899 distrib_id=""
5900 distrib_ver=""
5901 distrib_ver_minor=""
5902 distrib_ver_major=""
5903
5904 # Attempt to parse lsb-release to find out distribution and version. If not
5905 # found this should fail safe (test is supported).
5906 if [[ -f /etc/lsb-release ]]; then
5907
5908 while read -r lsb_line; do
5909 case "$lsb_line" in
5910 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5911 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5912 esac
5913 done < /etc/lsb-release
5914
5915 distrib_ver_major="${distrib_ver%%.*}"
5916 distrib_ver="${distrib_ver#*.}"
5917 distrib_ver_minor="${distrib_ver%%.*}"
5918 fi
5919
5920 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5921 # processor (as the CI does) can create a race condition whereby the build
5922 # fails to see a generated file, despite that file actually having been
5923 # generated. This problem appears to go away with 18.04 or newer, so make
5924 # the out of source tests unsupported on Ubuntu 16.04.
5925 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5926}
5927
Gilles Peskine8f073122018-11-27 15:58:47 +01005928component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005929 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005930 # generates
5931 make neat
5932
Gilles Peskine8f073122018-11-27 15:58:47 +01005933 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005934 MBEDTLS_ROOT_DIR="$PWD"
5935 mkdir "$OUT_OF_SOURCE_DIR"
5936 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005937 # Note: Explicitly generate files as these are turned off in releases
5938 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005939 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005940
Gilles Peskine8f073122018-11-27 15:58:47 +01005941 msg "test: cmake 'out-of-source' build"
5942 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005943 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005944 # Also ensure that there are no error messages such as
5945 # "No such file or directory", which would indicate that some required
5946 # file is missing (ssl-opt.sh tolerates the absence of some files so
5947 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005948 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005949 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005950 cat ssl-opt.err >&2
5951 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005952 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005953 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005954 cd "$MBEDTLS_ROOT_DIR"
5955 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005956}
Andres AGdc192212016-08-31 17:33:13 +01005957
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005958component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005959 # Remove existing generated files so that we use the ones CMake
5960 # generates
5961 make neat
5962
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005963 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005964 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005965 # Note: Explicitly generate files as these are turned off in releases
5966 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005967 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005968 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005969}
Gilles Peskinea3000992022-02-04 00:21:12 +01005970support_test_cmake_as_subdirectory () {
5971 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005972}
5973
Chris Kayd259e342021-03-25 16:03:25 +00005974component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005975 # Remove existing generated files so that we use the ones CMake
5976 # generates
5977 make neat
5978
Chris Kayd259e342021-03-25 16:03:25 +00005979 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005980 cd programs/test/cmake_package
5981 cmake .
5982 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005983 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005984}
Gilles Peskinea3000992022-02-04 00:21:12 +01005985support_test_cmake_as_package () {
5986 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005987}
5988
5989component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005990 # Remove existing generated files so that we use the ones CMake
5991 # generates
5992 make neat
5993
Chris Kayd259e342021-03-25 16:03:25 +00005994 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005995 cd programs/test/cmake_package_install
5996 cmake .
5997 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005998 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005999}
Gilles Peskinea3000992022-02-04 00:21:12 +01006000support_test_cmake_as_package_install () {
6001 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006002}
6003
David Horstmann20550e32023-01-12 14:17:01 +00006004component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006005 # Make a copy of config file to use for the in-tree test
6006 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006007
6008 MBEDTLS_ROOT_DIR="$PWD"
6009 mkdir "$OUT_OF_SOURCE_DIR"
6010 cd "$OUT_OF_SOURCE_DIR"
6011
David Horstmann969c1452023-01-31 10:34:44 +00006012 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006013 cmake "$MBEDTLS_ROOT_DIR"
6014 make
6015
6016 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6017 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006018 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006019 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6020 make
6021
6022 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6023 # In the user config, disable one feature (for simplicity, pick a feature
6024 # that nothing else depends on).
6025 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6026
6027 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6028 make
6029 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6030
6031 rm -f user_config.h full_config.h
6032
6033 cd "$MBEDTLS_ROOT_DIR"
6034 rm -rf "$OUT_OF_SOURCE_DIR"
6035
6036 # Now repeat the test for an in-tree build:
6037
David Horstmann969c1452023-01-31 10:34:44 +00006038 # Restore config for the in-tree test
6039 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006040
David Horstmann969c1452023-01-31 10:34:44 +00006041 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006042 cmake .
6043 make
6044
6045 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6046 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006047 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006048 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6049 make
6050
6051 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6052 # In the user config, disable one feature (for simplicity, pick a feature
6053 # that nothing else depends on).
6054 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6055
6056 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6057 make
6058 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6059
6060 rm -f user_config.h full_config.h
6061}
6062support_build_cmake_custom_config_file () {
6063 support_test_cmake_out_of_source
6064}
6065
David Horstmann041ed422024-05-10 14:37:48 +01006066component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006067 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006068 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6069 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6070 make
6071}
6072support_build_cmake_programs_no_testing () {
6073 support_test_cmake_out_of_source
6074}
David Horstmann20550e32023-01-12 14:17:01 +00006075
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006076component_build_zeroize_checks () {
6077 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6078
6079 scripts/config.py full
6080
6081 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006082 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 +01006083}
6084
6085
Gilles Peskine8f073122018-11-27 15:58:47 +01006086component_test_zeroize () {
6087 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6088 # different combinations of compilers and optimization flags by using an
6089 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6090 # system in all cases that the script fails, so we must manually search the
6091 # output to check whether the pass string is present and no failure strings
6092 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006093
Gilles Peskine4976e822019-01-06 19:52:22 +00006094 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6095 # about a spurious message if Gdb tries and fails, so suppress that.
6096 gdb_disable_aslr=
6097 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6098 gdb_disable_aslr='set disable-randomization off'
6099 fi
6100
Gilles Peskine8f073122018-11-27 15:58:47 +01006101 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006102 for compiler in clang gcc; do
6103 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6104 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006105 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6106 grep "The buffer was correctly zeroized" test_zeroize.log
6107 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006108 rm -f test_zeroize.log
6109 make clean
6110 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006111 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006112}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006113
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006114component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006115 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006116 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006117 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006118
6119 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006120 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006121}
6122
6123support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006124 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006125 ver="$(cmake --version)"
6126 ver="${ver#cmake version }"
6127 ver_major="${ver%%.*}"
6128
6129 ver="${ver#*.}"
6130 ver_minor="${ver%%.*}"
6131
6132 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006133}
6134
Gilles Peskinec848d222022-12-09 12:23:35 +01006135component_check_code_style () {
6136 msg "Check C code style"
6137 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006138}
6139
Gilles Peskinec848d222022-12-09 12:23:35 +01006140support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006141 case $(uncrustify --version) in
6142 *0.75.1*) true;;
6143 *) false;;
6144 esac
6145}
6146
Gilles Peskine8f073122018-11-27 15:58:47 +01006147component_check_python_files () {
6148 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006149 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006150}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006151
Joe Subbianid614c0b2021-07-29 11:18:29 +01006152component_check_test_helpers () {
6153 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006154 # unittest writes out mundane stuff like number or tests run on stderr.
6155 # Our convention is to reserve stderr for actual errors, and write
6156 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006157 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006158
Joe Subbiania25ffab2021-08-06 09:41:27 +01006159 msg "unit test: translate_ciphers.py"
6160 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006161}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006162
Valerio Settid9e42512024-05-06 15:59:51 +02006163component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006164 msg "build library for client"
6165
6166 helper_crypto_client_build client
6167
6168 msg "build library for server"
6169
6170 scripts/config.py crypto
6171
6172 helper_crypto_client_build server
6173
Valerio Settid9e42512024-05-06 15:59:51 +02006174 msg "build psasim"
Valerio Setti4362aae2024-05-09 09:15:39 +02006175 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Settid9e42512024-05-06 15:59:51 +02006176
6177 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006178 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006179
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006180 msg "build psasim to test psa_hash_compute"
6181 # Delete the executable to ensure we build using the right MAIN
6182 rm tests/psa-client-server/psasim/test/psa_client
6183 # API under test: psa_hash_compute()
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006184 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash_compute.c"
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006185
6186 msg "test psasim running psa_hash_compute"
6187 tests/psa-client-server/psasim/test/run_test.sh
6188
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006189 # Next APIs under test: psa_hash_*(). Just use the PSA hash example.
6190 aut_psa_hash="../../../programs/psa/psa_hash.c"
6191 if [ -f "tests/psa-client-server/psasim/$aut_psa_hash" ]; then
6192
6193 msg "build psasim to test all psa_hash_* APIs"
6194 # Delete the executable to ensure we build using the right MAIN
6195 rm tests/psa-client-server/psasim/test/psa_client
6196 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="$aut_psa_hash"
6197
6198 msg "test psasim running psa_hash sample"
6199 tests/psa-client-server/psasim/test/run_test.sh
6200 else
6201 echo $aut_psa_hash NOT FOUND, so not running that test
6202 fi
6203
Valerio Settid9e42512024-05-06 15:59:51 +02006204 msg "clean psasim"
6205 make -C tests/psa-client-server/psasim clean
6206}
Jerry Yud767cc42023-03-31 15:03:55 +08006207
Gilles Peskine192c72f2017-12-21 15:59:21 +01006208################################################################
6209#### Termination
6210################################################################
6211
Gilles Peskine8f073122018-11-27 15:58:47 +01006212post_report () {
6213 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006214 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006215
Gilles Peskine8f073122018-11-27 15:58:47 +01006216 final_report
6217}
6218
6219
6220
6221################################################################
6222#### Run all the things
6223################################################################
6224
Gilles Peskine5d996822020-03-28 21:09:21 +01006225# Function invoked by --error-test to test error reporting.
6226pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006227 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006228 if [ $KEEP_GOING -ne 0 ]; then
6229 echo "Expect three failing commands."
6230 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006231 # If the component doesn't run in a subshell, changing error_test_i to an
6232 # invalid integer will cause an error in the loop that runs this function.
6233 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006234 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006235 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006236 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006237 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006238 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006239 make unknown_target
6240 false "this should not be executed"
6241}
6242
Gilles Peskinee48351a2018-11-27 16:06:30 +01006243# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006244run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006245 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006246 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006247
6248 # Unconditionally create a seedfile that's sufficiently long.
6249 # Do this before each component, because a previous component may
6250 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006251 local dd_cmd
6252 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6253 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006254 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006255 esac
6256 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006257
Gilles Peskineec135542021-08-02 23:14:03 +02006258 # Run the component in a subshell, with error trapping and output
6259 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006260 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006261 # We want to keep running if the subshell fails, so 'set -e' must
6262 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006263 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006264 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006265 (
6266 if [ $QUIET -eq 1 ]; then
6267 # msg() will be silenced, so just print the component name here.
6268 echo "${current_component#component_}"
6269 exec >/dev/null
6270 fi
6271 if [ $KEEP_GOING -eq 1 ]; then
6272 # Keep "set -e" off, and run an ERR trap instead to record failures.
6273 set -E
6274 trap err_trap ERR
6275 fi
6276 # The next line is what runs the component
6277 "$@"
6278 if [ $KEEP_GOING -eq 1 ]; then
6279 trap - ERR
6280 exit $last_failure_status
6281 fi
6282 )
6283 component_status=$?
6284 if [ $KEEP_GOING -eq 1 ]; then
6285 set -e
6286 if [ $component_status -ne 0 ]; then
6287 failure_count=$((failure_count + 1))
6288 fi
6289 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006290
6291 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006292 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006293 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006294}
6295
6296# Preliminary setup
6297pre_check_environment
6298pre_initialize_variables
6299pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006300
Dave Rodgman21900632024-02-26 11:41:19 +00006301setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006302pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006303pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006304pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006305
Gilles Peskine878cf602019-01-06 20:50:38 +00006306build_status=0
6307if [ $KEEP_GOING -eq 1 ]; then
6308 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006309fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006310pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006311pre_print_configuration
6312pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006313cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006314if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006315 pre_generate_files
6316fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006317
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006318# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006319for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006320 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006321done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006322unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006323for component in $RUN_COMPONENTS; do
6324 run_component "component_$component"
6325done
Gilles Peskine8f073122018-11-27 15:58:47 +01006326
6327# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006328post_report