blob: d3bed3b11e7c6184ca233f534f42d0fac922b5ee [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
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100970 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200971 else
972 scripts/config.py crypto_full
973 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100974 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
975 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
976 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
977 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200978 fi
979
Valerio Settif57afd52024-05-14 10:39:20 +0200980 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200981}
982
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100983################################################################
984#### Configuration helpers
985################################################################
986
Valerio Settib2fd6732023-08-15 17:10:47 +0200987# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200988# The function optionally accepts 1 parameter: a space-separated list of the
989# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200990helper_disable_builtin_curves() {
991 allowed_list="${1:-}"
992 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
993
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200994 for curve in $allowed_list; do
995 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200996 done
997}
998
999# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1000# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1001# in the following helpers.
1002helper_get_psa_curve_list () {
1003 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001004 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1005 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001006 done
1007
1008 echo "$loc_list"
1009}
1010
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001011# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1012# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1013# in the following helpers.
1014helper_get_psa_dh_group_list () {
1015 loc_list=""
1016 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1017 loc_list="$loc_list $item"
1018 done
1019
1020 echo "$loc_list"
1021}
1022
Valerio Settib2fd6732023-08-15 17:10:47 +02001023# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001024# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001025# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001026helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001027 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001028 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001029 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 +02001030 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1031 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001032 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1033 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001034 fi
1035 done
1036
1037 echo "$loc_list"
1038}
1039
Gilles Peskine192c72f2017-12-21 15:59:21 +01001040################################################################
1041#### Basic checks
1042################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001043
1044#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001045# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001046#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001047# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001048# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001049# 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 +02001050# time, so start with a GCC build).
1051# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001052#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001053# Indicative running times are given for reference.
1054
Gilles Peskine8f073122018-11-27 15:58:47 +01001055component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001056 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001057 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001058}
Janos Follathb72c6782016-07-19 14:54:17 +01001059
Gilles Peskine67debb62021-05-18 16:09:50 +02001060component_check_generated_files () {
1061 msg "Check: check-generated-files, files generated with make" # 2s
1062 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001063 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001064
1065 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001066 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001067 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001068 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001069
1070 msg "Check: check-generated-files -u, files absent" # 2s
1071 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001072 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001073 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001074 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001075
1076 # This component ends with the generated files present in the source tree.
1077 # This is necessary for subsequent components!
1078}
1079
Gilles Peskine8f073122018-11-27 15:58:47 +01001080component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001081 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001082 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001083}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001084
Gilles Peskine8f073122018-11-27 15:58:47 +01001085component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001086 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001087 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001088}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001089
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001090component_check_changelog () {
1091 msg "Check: changelog entries" # < 1s
1092 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001093 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001094 if [ -e ChangeLog.new ]; then
1095 # Show the diff for information. It isn't an error if the diff is
1096 # non-empty.
1097 diff -u ChangeLog ChangeLog.new || true
1098 rm ChangeLog.new
1099 fi
1100}
1101
Gilles Peskine8f073122018-11-27 15:58:47 +01001102component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001103 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001104 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001105}
Darryl Greena07039c2018-03-13 16:48:16 +00001106
Gilles Peskine895868b2019-09-19 21:30:05 +02001107component_check_test_cases () {
1108 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001109 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001110 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001111 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001112 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001113 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001114 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001115 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001116}
1117
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001118component_check_test_dependencies () {
1119 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001120 # The purpose of this component is to catch unjustified dependencies on
1121 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1122 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1123 # MBEDTLS_PSA_xxx).
1124 #
1125 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1126 # this component is meant to catch. However a few of them are justified,
1127 # mostly by the absence of a PSA equivalent, so this component includes a
1128 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001129
1130 found="check-test-deps-found-$$"
1131 expected="check-test-deps-expected-$$"
1132
1133 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001134 grep 'depends_on' \
1135 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001136 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001137 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001138 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001139
Yanray Wang18040ed2023-11-23 21:29:56 +08001140 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001141 rm -f $expected
1142 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1143 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001144 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1145 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001146 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1147 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001148 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1149 # the test code and that's probably the most convenient way of achieving
1150 # the test's goal.
1151 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1152 # No PSA equivalent - we should probably have one in the future.
1153 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1154 # No PSA equivalent - needed by some init tests
1155 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001156 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001157 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001158
1159 # Compare reality with expectation.
1160 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001161 #
1162 # The output should be empty. When it's not:
1163 # - Each '+' line is a macro that was found but not expected. You want to
1164 # find where that macro occurs, and either replace it with PSA macros, or
1165 # add it to the exceptions list above with a justification.
1166 # - Each '-' line is a macro that was expected but not found; it means the
1167 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001168 diff -U0 $expected $found
1169
1170 rm $found $expected
1171}
1172
Gilles Peskine8f073122018-11-27 15:58:47 +01001173component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001174 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001175 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001176}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001177
Gilles Peskine192c72f2017-12-21 15:59:21 +01001178
Gilles Peskine636c26a2020-03-04 20:46:15 +01001179
Gilles Peskine192c72f2017-12-21 15:59:21 +01001180################################################################
1181#### Build and test many configurations and targets
1182################################################################
1183
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001184component_test_default_out_of_box () {
1185 msg "build: make, default config (out-of-box)" # ~1min
1186 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001187 # Disable fancy stuff
1188 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001189
1190 msg "test: main suites make, default config (out-of-box)" # ~10s
1191 make test
1192
1193 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001194 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001195
1196 msg "program demos: make, default config (out-of-box)" # ~10s
1197 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001198}
1199
Gilles Peskine8f073122018-11-27 15:58:47 +01001200component_test_default_cmake_gcc_asan () {
1201 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001202 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1203 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001204
Gilles Peskine8f073122018-11-27 15:58:47 +01001205 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1206 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001207
Gilles Peskine82b27272019-06-14 18:27:03 +02001208 msg "program demos (ASan build)" # ~10s
1209 tests/scripts/run_demos.py
1210
Gilles Peskine97bea012020-04-23 23:37:45 +02001211 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001212 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001213
Gilles Peskine6848d172023-11-02 19:58:03 +01001214 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001215 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001216
Gilles Peskine8f073122018-11-27 15:58:47 +01001217 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001218 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001219
Gilles Peskine8f073122018-11-27 15:58:47 +01001220 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001221 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001222
1223 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001224 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001225}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001226
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001227component_test_default_cmake_gcc_asan_new_bignum () {
1228 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001229 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001230 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001231 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001232
1233 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1234 make test
1235
1236 msg "test: selftest (ASan build)" # ~ 10s
1237 programs/test/selftest
1238
1239 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1240 tests/ssl-opt.sh
1241
1242 msg "test: compat.sh (ASan build)" # ~ 6 min
1243 tests/compat.sh
1244
1245 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1246 tests/context-info.sh
1247}
1248
Hanno Becker01635512019-02-26 14:27:09 +00001249component_test_full_cmake_gcc_asan () {
1250 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001251 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001252 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1253 make
1254
1255 msg "test: main suites (inc. selftests) (full config, ASan build)"
1256 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001257
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001258 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001259 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001260
Gilles Peskine636c26a2020-03-04 20:46:15 +01001261 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001262 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001263
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001264 # Note: the next two invocations cover all compat.sh test cases.
1265 # We should use the same here and in basic-build-test.sh.
1266 msg "test: compat.sh: default version (full config, ASan build)"
1267 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001268
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001269 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1270 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001271
1272 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001273 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001274}
1275
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001276
1277component_test_full_cmake_gcc_asan_new_bignum () {
1278 msg "build: full config, cmake, gcc, ASan"
1279 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001280 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001281 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001282 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001283
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001284 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001285 make test
1286
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001287 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001288 programs/test/selftest
1289
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001290 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001291 tests/ssl-opt.sh
1292
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001293 # Note: the next two invocations cover all compat.sh test cases.
1294 # We should use the same here and in basic-build-test.sh.
1295 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1296 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001297
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001298 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1299 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001300
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001301 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001302 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001303}
1304
Ronald Cronc3623db2020-10-29 10:51:32 +01001305component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001306 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001307 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001308 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1309 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1310 make
1311
1312 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1313 make test
1314}
1315
David Horstmann4a48bec2024-03-13 15:42:31 +00001316component_test_psa_assume_exclusive_buffers () {
1317 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001318 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001319 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001320 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1321 make
1322
David Horstmann4a48bec2024-03-13 15:42:31 +00001323 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001324 make test
1325}
1326
Gilles Peskinea3548672021-06-17 11:37:52 +02001327# check_renamed_symbols HEADER LIB
1328# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1329# name is LIB.
1330check_renamed_symbols () {
1331 ! nm "$2" | sed 's/.* //' |
1332 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1333}
1334
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001335component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001336 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001337 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001338 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1339 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1340 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1341 # We can only compile, not link, since our test and sample programs
1342 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1343 # is active.
1344 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001345
1346 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1347 # version is not present.
1348 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001349 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001350}
1351
Valerio Setti63097752024-03-12 13:18:13 +01001352# Get a list of library-wise undefined symbols and ensure that they only
1353# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1354# This function is a common helper used by both:
1355# - component_test_default_psa_crypto_client_without_crypto_provider
1356# - component_build_full_psa_crypto_client_without_crypto_provider.
1357common_check_mbedtls_missing_symbols() {
1358 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1359 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1360 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1361 not grep mbedtls_ linking_errors.txt
1362
1363 rm sym_def.txt sym_undef.txt linking_errors.txt
1364}
1365
1366component_test_default_psa_crypto_client_without_crypto_provider () {
1367 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1368
Ronald Cron336678b2021-01-28 17:54:24 +01001369 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1370 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001371 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001372 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001373 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001374 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001375
Ronald Cron336678b2021-01-28 17:54:24 +01001376 make
1377
Valerio Setti63097752024-03-12 13:18:13 +01001378 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1379 common_check_mbedtls_missing_symbols
1380
1381 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001382 make test
1383}
1384
Valerio Setti63097752024-03-12 13:18:13 +01001385component_build_full_psa_crypto_client_without_crypto_provider () {
1386 msg "build: full config - PSA_CRYPTO_C"
1387
1388 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1389 scripts/config.py full
1390
1391 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1392 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1393 # Dynamic secure element support is a deprecated feature and it is not
1394 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1395 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1396
1397 # Since there is no crypto provider in this build it is not possible to
1398 # build all the test executables and progrems due to missing PSA functions
1399 # at link time. Therefore we will just build libraries and we'll check
1400 # that symbols of interest are there.
1401 make lib
1402
1403 msg "check missing symbols: full config - PSA_CRYPTO_C"
1404
1405 common_check_mbedtls_missing_symbols
1406
1407 # Ensure that desired functions are included into the build (extend the
1408 # following list as required).
1409 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1410 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1411 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1412}
1413
Ryan Everettdaa322a2024-04-18 16:48:55 +01001414component_test_no_rsa_key_pair_generation() {
1415 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001416 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001417 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001418 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001419 make
1420
Ryan Everettdaa322a2024-04-18 16:48:55 +01001421 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001422 make test
1423}
1424
Gilles Peskine782f4112018-11-27 16:11:09 +01001425component_test_ref_configs () {
1426 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001427 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1428 # want to re-generate generated files that depend on it, quite correctly.
1429 # However this doesn't work as the generation script expects a specific
1430 # format for mbedtls_config.h, which the other files don't follow. Also,
1431 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001432 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001433 # whether they're on or off. So, disable cmake's (over-sensitive here)
1434 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001435 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001436 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001437 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001438}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001439
Gilles Peskine8f073122018-11-27 15:58:47 +01001440component_test_no_renegotiation () {
1441 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001442 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001443 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001444 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001445
Gilles Peskine8f073122018-11-27 15:58:47 +01001446 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1447 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001448
Gilles Peskine8f073122018-11-27 15:58:47 +01001449 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001450 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001451}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001452
Gilles Peskine636c26a2020-03-04 20:46:15 +01001453component_test_no_pem_no_fs () {
1454 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1455 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1456 scripts/config.py unset MBEDTLS_FS_IO
1457 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1458 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001459 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001460 make
1461
1462 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1463 make test
1464
1465 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001466 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001467}
1468
Gilles Peskine8f073122018-11-27 15:58:47 +01001469component_test_rsa_no_crt () {
1470 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001471 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001472 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001473 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001474
Gilles Peskine8f073122018-11-27 15:58:47 +01001475 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1476 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001477
Gilles Peskine8f073122018-11-27 15:58:47 +01001478 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001479 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001480
Gilles Peskine8f073122018-11-27 15:58:47 +01001481 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001482 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001483
1484 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001485 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001486}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001487
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001488component_test_no_ctr_drbg_classic () {
1489 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001490 scripts/config.py full
1491 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001492 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001493 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001494
Dave Rodgman17127e92023-12-14 16:42:48 +00001495 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001496 make
1497
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001498 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001499 make test
1500
Gilles Peskineba749042021-01-13 20:02:03 +01001501 # In this configuration, the TLS test programs use HMAC_DRBG.
1502 # The SSL tests are slow, so run a small subset, just enough to get
1503 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001504 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001505 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001506
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001508 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001509}
1510
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001511component_test_no_ctr_drbg_use_psa () {
1512 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001513 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001514 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1515 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001516
Dave Rodgman17127e92023-12-14 16:42:48 +00001517 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001518 make
1519
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001520 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1521 make test
1522
1523 # In this configuration, the TLS test programs use HMAC_DRBG.
1524 # The SSL tests are slow, so run a small subset, just enough to get
1525 # confidence that the SSL code copes with HMAC_DRBG.
1526 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001527 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001528
1529 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001530 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001531}
1532
1533component_test_no_hmac_drbg_classic () {
1534 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1535 scripts/config.py full
1536 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1537 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1538 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001539 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540
Dave Rodgman17127e92023-12-14 16:42:48 +00001541 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001542 make
1543
1544 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001545 make test
1546
Gilles Peskinea2224342020-11-19 22:14:34 +01001547 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1548 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1549 # instead.
1550 # Test SSL with non-deterministic ECDSA. Only test features that
1551 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001552 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001553 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001554
1555 # To save time, only test one protocol version, since this part of
1556 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001557 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001558 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001559}
1560
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001561component_test_no_hmac_drbg_use_psa () {
1562 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1563 scripts/config.py full
1564 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1565 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1566 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1567
Dave Rodgman17127e92023-12-14 16:42:48 +00001568 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001569 make
1570
1571 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1572 make test
1573
1574 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1575 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1576 # instead.
1577 # Test SSL with non-deterministic ECDSA. Only test features that
1578 # might be affected by how ECDSA signature is performed.
1579 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001580 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001581
1582 # To save time, only test one protocol version, since this part of
1583 # the protocol is identical in (D)TLS up to 1.2.
1584 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001585 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001586}
1587
1588component_test_psa_external_rng_no_drbg_classic () {
1589 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1590 scripts/config.py full
1591 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001592 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001593 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001594 scripts/config.py unset MBEDTLS_ENTROPY_C
1595 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1596 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001597 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1598 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1599 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001600 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1601 # the SSL test programs don't have an RNG and can't work. Explicitly
1602 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001603 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001604
1605 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1606 make test
1607
Gilles Peskine8eb29432021-02-03 20:07:11 +01001608 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001609 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001610}
1611
1612component_test_psa_external_rng_no_drbg_use_psa () {
1613 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001614 scripts/config.py full
1615 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001616 scripts/config.py unset MBEDTLS_ENTROPY_C
1617 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1618 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001619 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1620 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1621 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001622 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001623
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001624 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001625 make test
1626
Gilles Peskine8eb29432021-02-03 20:07:11 +01001627 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001628 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001629}
1630
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001631component_test_psa_external_rng_use_psa_crypto () {
1632 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1633 scripts/config.py full
1634 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1635 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1636 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001637 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001638
1639 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1640 make test
1641
1642 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1643 tests/ssl-opt.sh -f 'Default\|opaque'
1644}
1645
Gilles Peskine801c4332023-04-28 21:04:28 +02001646component_test_psa_inject_entropy () {
1647 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1648 scripts/config.py full
1649 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1650 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1651 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1652 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1653 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1654 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001655 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 +02001656
1657 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1658 make test
1659}
1660
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001661component_test_sw_inet_pton () {
1662 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1663
1664 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1665 scripts/config.py set MBEDTLS_TEST_HOOKS
1666 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1667
1668 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1669 make test
1670}
1671
Valerio Settia41654d2024-02-08 10:33:11 +01001672component_full_no_pkparse_pkwrite() {
1673 msg "build: full without pkparse and pkwrite"
1674
1675 scripts/config.py crypto_full
1676 scripts/config.py unset MBEDTLS_PK_PARSE_C
1677 scripts/config.py unset MBEDTLS_PK_WRITE_C
1678
Valerio Settia41654d2024-02-08 10:33:11 +01001679 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1680
1681 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1682 not grep mbedtls_pk_parse_key library/pkparse.o
1683 not grep mbedtls_pk_write_key_der library/pkwrite.o
1684
1685 msg "test: full without pkparse and pkwrite"
1686 make test
1687}
1688
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001689component_test_crypto_full_md_light_only () {
1690 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001691 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001692
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001693 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001694 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001695 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001696 scripts/config.py unset MBEDTLS_HKDF_C
1697 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001698 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001699 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001700 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001701 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
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
Ronald Cron8dbea482024-05-23 16:04:11 +02001717component_test_full_no_cipher () {
1718 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001719
1720 scripts/config.py full
1721 scripts/config.py unset MBEDTLS_CIPHER_C
1722
Ronald Cron8dbea482024-05-23 16:04:11 +02001723 # The built-in implementation of the following algs/key-types depends
1724 # on CIPHER_C so we disable them.
1725 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1726 # so we keep them enabled.
1727 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1729 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1730 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1731 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1732 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1733 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1734 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1735 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1736 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1737 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1738
Valerio Settic84d9402023-10-23 14:58:25 +02001739 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001740 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001741 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001742
Gilles Peskine21570cf2023-12-22 11:49:50 +01001743 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001744
Valerio Setti7e710e82023-08-25 09:14:15 +02001745 # Ensure that CIPHER_C was not re-enabled
1746 not grep mbedtls_cipher_init library/cipher.o
1747
Ronald Cron8dbea482024-05-23 16:04:11 +02001748 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001749 make test
1750}
1751
Valerio Settibdfecb62023-11-07 15:37:20 +01001752component_test_full_no_ccm() {
1753 msg "build: full no PSA_WANT_ALG_CCM"
1754
1755 # Full config enables:
1756 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1757 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1758 scripts/config.py full
1759
1760 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1761 # enabled, but not used from TLS since USE_PSA is set.
1762 # This is helpful to ensure that TLS tests below have proper dependencies.
1763 #
1764 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1765 # PSA_WANT_ALG_CCM to be re-enabled.
1766 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1767
Gilles Peskine21570cf2023-12-22 11:49:50 +01001768 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001769
1770 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001771 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001772}
1773
1774component_test_full_no_ccm_star_no_tag() {
1775 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1776
1777 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1778 scripts/config.py full
1779
1780 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1781 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1782 # This basically disables all unauthenticated ciphers on the PSA side, while
1783 # keeping AEADs enabled.
1784 #
1785 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1786 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1787 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1788 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1789 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1790 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1791 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1792 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1793 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1794 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1795
Gilles Peskine21570cf2023-12-22 11:49:50 +01001796 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001797
1798 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001799 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001800
1801 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001802 make test
1803}
1804
Valerio Settie1655b82023-01-03 15:35:25 +01001805component_test_full_no_bignum () {
1806 msg "build: full minus bignum"
1807 scripts/config.py full
1808 scripts/config.py unset MBEDTLS_BIGNUM_C
1809 # Direct dependencies of bignum
1810 scripts/config.py unset MBEDTLS_ECP_C
1811 scripts/config.py unset MBEDTLS_RSA_C
1812 scripts/config.py unset MBEDTLS_DHM_C
1813 # Direct dependencies of ECP
1814 scripts/config.py unset MBEDTLS_ECDH_C
1815 scripts/config.py unset MBEDTLS_ECDSA_C
1816 scripts/config.py unset MBEDTLS_ECJPAKE_C
1817 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001818 # Disable what auto-enables ECP_LIGHT
1819 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1820 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001821 # Indirect dependencies of ECP
1822 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1823 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1824 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1825 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1826 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1827 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1828 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1829 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1830 # Direct dependencies of DHM
1831 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1832 # Direct dependencies of RSA
1833 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1834 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1835 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1836 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1837 # PK and its dependencies
1838 scripts/config.py unset MBEDTLS_PK_C
1839 scripts/config.py unset MBEDTLS_PK_PARSE_C
1840 scripts/config.py unset MBEDTLS_PK_WRITE_C
1841 scripts/config.py unset MBEDTLS_X509_USE_C
1842 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1843 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1844 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1845 scripts/config.py unset MBEDTLS_X509_CREATE_C
1846 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1847 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1848 scripts/config.py unset MBEDTLS_PKCS7_C
1849 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1850 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1851 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1852
Gilles Peskine21570cf2023-12-22 11:49:50 +01001853 make
Valerio Settie1655b82023-01-03 15:35:25 +01001854
1855 msg "test: full minus bignum"
1856 make test
1857}
1858
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001859component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001860 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001861
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001862 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001863 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001864 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001865 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001866 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001867 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1868 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001869 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001870 scripts/config.py unset MBEDTLS_GCM_C
1871 scripts/config.py unset MBEDTLS_CCM_C
1872 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001873 #Disable TLS 1.3 (as no AEAD)
1874 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001875 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1876 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1877 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001878 # 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 +01001879 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001880 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001881 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001882 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001883 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1884 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001885 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001886 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001887 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001888
Przemek Stekiel9550c052022-09-28 09:51:55 +02001889 make
1890
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001891 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001892 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001893
1894 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001895}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001896
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001897component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001898 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001899
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001900 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001901 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001902 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001903 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001904 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001905 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1906 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001907 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001908 scripts/config.py unset MBEDTLS_GCM_C
1909 scripts/config.py unset MBEDTLS_CCM_C
1910 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001911 #Disable TLS 1.3 (as no AEAD)
1912 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001913 # 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 +01001914 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001915 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001916 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001917 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001918 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001919 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001920 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001921 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001922
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001923 make
1924
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001925 msg "test: default with only CBC-legacy cipher use psa"
1926 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001927
1928 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1929 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001930}
1931
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001932component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001933 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001934
1935 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001936 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001937 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001938 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001939 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001940 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1941 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001942 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001943 scripts/config.py unset MBEDTLS_GCM_C
1944 scripts/config.py unset MBEDTLS_CCM_C
1945 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001946 #Disable TLS 1.3 (as no AEAD)
1947 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001948 # 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 +01001949 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001950 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1951 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1952 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001953 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001954 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001955 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001956 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001957
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001958 make
1959
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001960 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001961 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001962
1963 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1964 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001965}
1966
Valerio Setti9f0ec532022-11-08 13:03:24 +01001967# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1968# that we could use for interop testing. However, we now have sort of two
1969# implementations ourselves: one using PSA, the other not. At least test that
1970# these two interoperate with each other.
1971component_test_tls1_2_ecjpake_compatibility() {
1972 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1973 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001974 # Explicitly make lib first to avoid a race condition:
1975 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1976 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001977 make -C programs ssl/ssl_server2 ssl/ssl_client2
1978 cp programs/ssl/ssl_server2 s2_no_use_psa
1979 cp programs/ssl/ssl_client2 c2_no_use_psa
1980
1981 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1982 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1983 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001984 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001985 make -C programs ssl/ssl_server2 ssl/ssl_client2
1986 make -C programs test/udp_proxy test/query_compile_time_config
1987
Valerio Setti70e02902022-12-02 16:21:56 +01001988 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1989 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1990 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1991 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1992 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1993 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1994 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1995 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 +01001996
1997 rm s2_no_use_psa c2_no_use_psa
1998}
1999
Gilles Peskine636c26a2020-03-04 20:46:15 +01002000component_test_everest () {
2001 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01002002 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2003 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2004 make
2005
2006 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2007 make test
2008
Gilles Peskine6848d172023-11-02 19:58:03 +01002009 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002010 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002011
Gilles Peskine636c26a2020-03-04 20:46:15 +01002012 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002013 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01002014
2015 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2016 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002017 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002018}
2019
Gilles Peskined3beca92020-07-03 00:15:37 +02002020component_test_everest_curve25519_only () {
2021 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002022 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02002023 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2024 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002025 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
2026 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
2027 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02002028 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2029 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002030 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002031 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
2032
Gilles Peskined3beca92020-07-03 00:15:37 +02002033 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002034 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002035 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
2036 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02002037
Dave Rodgman17127e92023-12-14 16:42:48 +00002038 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002039
2040 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2041 make test
2042}
2043
Gilles Peskine8f073122018-11-27 15:58:47 +01002044component_test_small_ssl_out_content_len () {
2045 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002046 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2047 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002048 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002049 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002050
Gilles Peskine8f073122018-11-27 15:58:47 +01002051 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002052 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002053}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002054
Gilles Peskine8f073122018-11-27 15:58:47 +01002055component_test_small_ssl_in_content_len () {
2056 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002057 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2058 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002059 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002060 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002061
Gilles Peskine8f073122018-11-27 15:58:47 +01002062 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002063 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002064}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002065
Gilles Peskine8f073122018-11-27 15:58:47 +01002066component_test_small_ssl_dtls_max_buffering () {
2067 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002068 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002069 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002070 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002071
Gilles Peskine8f073122018-11-27 15:58:47 +01002072 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002073 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 +01002074}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002075
Gilles Peskine8f073122018-11-27 15:58:47 +01002076component_test_small_mbedtls_ssl_dtls_max_buffering () {
2077 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002078 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002079 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002080 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002081
Gilles Peskine8f073122018-11-27 15:58:47 +01002082 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002083 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002084}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002085
Gilles Peskine75cc7712019-09-06 19:47:17 +02002086component_test_psa_collect_statuses () {
2087 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002088 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002089 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002090 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002091 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002092 rm -f tests/statuses.log
2093}
2094
Gilles Peskine8f073122018-11-27 15:58:47 +01002095component_test_full_cmake_clang () {
2096 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002097 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002098 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 +01002099 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002100
k-stachowiak0291cb72019-06-26 15:52:12 +02002101 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002102 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002103
Gilles Peskineda6017c2022-10-30 21:02:40 +01002104 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2105 programs/test/cpp_dummy_build
2106
Gilles Peskine6848d172023-11-02 19:58:03 +01002107 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002108 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002109
Gilles Peskine82b27272019-06-14 18:27:03 +02002110 msg "program demos (full config, clang)" # ~10s
2111 tests/scripts/run_demos.py
2112
k-stachowiak0291cb72019-06-26 15:52:12 +02002113 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002114 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002115
Gilles Peskine8f073122018-11-27 15:58:47 +01002116 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002117 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002118}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002119
Gilles Peskine0c671602022-11-29 16:01:41 +01002120skip_suites_without_constant_flow () {
2121 # Skip the test suites that don't have any constant-flow annotations.
2122 # This will need to be adjusted if we ever start declaring things as
2123 # secret from macros or functions inside tests/include or tests/src.
2124 SKIP_TEST_SUITES=$(
2125 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2126 sed 's/test_suite_//; s/\.function$//' |
2127 tr '\n' ,)
2128 export SKIP_TEST_SUITES
2129}
2130
Dave Rodgman246210e2023-07-31 18:07:44 +01002131skip_all_except_given_suite () {
2132 # Skip all but the given test suite
2133 SKIP_TEST_SUITES=$(
2134 ls -1 tests/suites/test_suite_*.function |
2135 grep -v $1.function |
2136 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2137 tr '\n' ,)
2138 export SKIP_TEST_SUITES
2139}
2140
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002141component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002142 # This tests both (1) accesses to undefined memory, and (2) branches or
2143 # memory access depending on secret values. To distinguish between those:
2144 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2145 # - or alternatively, change the build type to MemSanDbg, which enables
2146 # origin tracking and nicer stack traces (which are useful for debugging
2147 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002148 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2149 scripts/config.py full
2150 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2151 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2152 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2153 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2154 make
2155
2156 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2157 make test
2158}
2159
2160component_test_memsan_constant_flow_psa () {
2161 # This tests both (1) accesses to undefined memory, and (2) branches or
2162 # memory access depending on secret values. To distinguish between those:
2163 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2164 # - or alternatively, change the build type to MemSanDbg, which enables
2165 # origin tracking and nicer stack traces (which are useful for debugging
2166 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002167 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002168 scripts/config.py full
2169 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2170 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2171 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2172 make
2173
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002174 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002175 make test
2176}
2177
Bence Szépkúti0354d042023-12-06 16:14:37 +01002178component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002179 # This tests both (1) everything that valgrind's memcheck usually checks
2180 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2181 # etc.) and (2) branches or memory access depending on secret values,
2182 # which will be reported as uninitialized memory. To distinguish between
2183 # secret and actually uninitialized:
2184 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2185 # - or alternatively, build with debug info and manually run the offending
2186 # test suite with valgrind --track-origins=yes, then check if the origin
2187 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002188 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2189 scripts/config.py full
2190 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2191 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002192 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002193 cmake -D CMAKE_BUILD_TYPE:String=Release .
2194 make
2195
2196 # this only shows a summary of the results (how many of each type)
2197 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002198 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002199 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002200
2201 # Test asm path in constant time module - by default, it will test the plain C
2202 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2203 msg "test: valgrind asm constant_time"
2204 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2205 skip_all_except_given_suite test_suite_constant_time
2206 cmake -D CMAKE_BUILD_TYPE:String=Release .
2207 make clean
2208 make
2209 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002210}
2211
Bence Szépkúti0354d042023-12-06 16:14:37 +01002212component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002213 # This tests both (1) everything that valgrind's memcheck usually checks
2214 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2215 # etc.) and (2) branches or memory access depending on secret values,
2216 # which will be reported as uninitialized memory. To distinguish between
2217 # secret and actually uninitialized:
2218 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2219 # - or alternatively, build with debug info and manually run the offending
2220 # test suite with valgrind --track-origins=yes, then check if the origin
2221 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002222 msg "build: cmake release GCC, full config with constant flow testing"
2223 scripts/config.py full
2224 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002225 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002226 cmake -D CMAKE_BUILD_TYPE:String=Release .
2227 make
2228
2229 # this only shows a summary of the results (how many of each type)
2230 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002231 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002232 make memcheck
2233}
2234
Janos Follath9338cac2023-10-04 18:55:39 +01002235component_test_tsan () {
2236 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002237 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002238 scripts/config.py set MBEDTLS_THREADING_C
2239 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002240 # Self-tests do not currently use multiple threads.
2241 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002242
Ryan6caf84f2024-03-05 13:57:00 +00002243 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2244 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2245
Janos Follath9338cac2023-10-04 18:55:39 +01002246 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2247 make
2248
2249 msg "test: main suites (TSan)"
2250 make test
2251}
2252
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002253component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002254 # Test that removing the deprecated features from the default
2255 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002256 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2257 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002258 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002259
2260 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2261 make test
2262}
2263
2264component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002265 msg "build: make, full_no_deprecated config" # ~ 30s
2266 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002267 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002268
Gilles Peskine30de2e82020-04-20 21:39:22 +02002269 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002270 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002271
2272 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2273 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002274}
2275
Gilles Peskine8386ea22020-04-30 09:07:29 +02002276component_test_full_no_deprecated_deprecated_warning () {
2277 # Test that there is nothing deprecated in "full_no_deprecated".
2278 # A deprecated feature would trigger a warning (made fatal) from
2279 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002280 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2281 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002282 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2283 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002284 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002285
Gilles Peskine30de2e82020-04-20 21:39:22 +02002286 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002287 make test
2288}
2289
Gilles Peskine8386ea22020-04-30 09:07:29 +02002290component_test_full_deprecated_warning () {
2291 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2292 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002293 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002294 scripts/config.py full
2295 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002296 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002297 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2298 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002299 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002300
Gilles Peskine8386ea22020-04-30 09:07:29 +02002301 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2302 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2303 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002304 # Expect warnings from '#warning' directives in check_config.h and
2305 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002306 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 +01002307
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002308 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2309 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002310
2311 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2312 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002313}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002314
Gilles Peskineec541fe2020-01-31 14:24:14 +01002315# Check that the specified libraries exist and are empty.
2316are_empty_libraries () {
2317 nm "$@" >/dev/null 2>/dev/null
2318 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2319}
2320
2321component_build_crypto_default () {
2322 msg "build: make, crypto only"
2323 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002324 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002325 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002326}
2327
2328component_build_crypto_full () {
2329 msg "build: make, crypto only, full config"
2330 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002331 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002332 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002333}
2334
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002335component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002336 msg "build: make, config for PSA crypto service"
2337 scripts/config.py crypto
2338 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2339 # Disable things that are not needed for just cryptography, to
2340 # reach a configuration that would be typical for a PSA cryptography
2341 # service providing all implemented PSA algorithms.
2342 # System stuff
2343 scripts/config.py unset MBEDTLS_ERROR_C
2344 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002345 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002346 # Crypto stuff with no PSA interface
2347 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002348 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002349 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002350 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002351 scripts/config.py unset MBEDTLS_NIST_KW_C
2352 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2353 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2354 scripts/config.py unset MBEDTLS_PKCS12_C
2355 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002356 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2357 # in PSA code to work with RSA keys. We don't require users to set those:
2358 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002359 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002360 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002361 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002362 make CFLAGS='-O1 -Werror' all test
2363 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2364}
2365
Gilles Peskineec541fe2020-01-31 14:24:14 +01002366component_build_crypto_baremetal () {
2367 msg "build: make, crypto only, baremetal config"
2368 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002369 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002370 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002371}
Daniel Axtens446af202020-09-02 21:30:13 +10002372support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002373 support_build_baremetal "$@"
2374}
2375
2376component_build_baremetal () {
2377 msg "build: make, baremetal config"
2378 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002379 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002380}
2381support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002382 # Older Glibc versions include time.h from other headers such as stdlib.h,
2383 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2384 # problem, Ubuntu 18.04 is ok.
2385 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2386}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002387
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002388# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002389component_test_depends_py_cipher_id () {
2390 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002391 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002392}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002393
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002394component_test_depends_py_cipher_chaining () {
2395 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002396 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002397}
2398
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002399component_test_depends_py_cipher_padding () {
2400 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002401 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002402}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002403
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002404component_test_depends_py_curves () {
2405 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002406 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002407}
2408
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002409component_test_depends_py_hashes () {
2410 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002411 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002412}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002413
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002414component_test_depends_py_kex () {
2415 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002416 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002417}
2418
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002419component_test_depends_py_pkalgs () {
2420 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002421 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002422}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002423
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002424# PSA equivalents of the depends.py tests
2425component_test_depends_py_cipher_id_psa () {
2426 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002427 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002428}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002429
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002430component_test_depends_py_cipher_chaining_psa () {
2431 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002432 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002433}
2434
2435component_test_depends_py_cipher_padding_psa () {
2436 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002437 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002438}
2439
2440component_test_depends_py_curves_psa () {
2441 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002442 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002443}
2444
2445component_test_depends_py_hashes_psa () {
2446 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002447 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002448}
2449
2450component_test_depends_py_kex_psa () {
2451 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002452 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002453}
2454
2455component_test_depends_py_pkalgs_psa () {
2456 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002457 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002458}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002459
Valerio Setti6bed64e2024-01-17 15:21:44 +01002460component_test_psa_crypto_config_ffdh_2048_only () {
2461 msg "build: full config - only DH 2048"
2462
2463 scripts/config.py full
2464
2465 # Disable all DH groups other than 2048.
2466 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2467 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2468 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2469 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2470
2471 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2472
2473 msg "test: full config - only DH 2048"
2474 make test
2475
2476 msg "ssl-opt: full config - only DH 2048"
2477 tests/ssl-opt.sh -f "ffdh"
2478}
2479
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002480component_build_no_pk_rsa_alt_support () {
2481 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2482
2483 scripts/config.py full
2484 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2485 scripts/config.py set MBEDTLS_RSA_C
2486 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2487
2488 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002489 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002490}
2491
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002492component_build_module_alt () {
2493 msg "build: MBEDTLS_XXX_ALT" # ~30s
2494 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002495
2496 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002497 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2498 scripts/config.py unset MBEDTLS_AESNI_C
2499 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002500 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002501 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2502 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002503 # You can only have one threading implementation: alt or pthread, not both.
2504 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002505 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2506 # directly and assumes the implementation works with partial groups.
2507 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002508 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2509 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2510 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002511 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2512 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2513 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002514
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002515 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2516 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2517 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002518 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002519
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002520 # We can only compile, not link, since we don't have any implementations
2521 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002522 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002523}
2524
2525component_build_dhm_alt () {
2526 msg "build: MBEDTLS_DHM_ALT" # ~30s
2527 scripts/config.py full
2528 scripts/config.py set MBEDTLS_DHM_ALT
2529 # debug.c currently references mbedtls_dhm_context fields directly.
2530 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002531 # We can only compile, not link, since we don't have any implementations
2532 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002533 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002534}
2535
Gilles Peskine64996c32024-01-23 20:25:47 +01002536component_test_no_psa_crypto_full_cmake_asan() {
2537 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2538 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002539 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002540 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002541 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002542 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002543 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002544 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002545 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002546 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002547 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002548 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002549 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002550 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002551
Gilles Peskine64996c32024-01-23 20:25:47 +01002552 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002553 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002554
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002555 # Note: ssl-opt.sh has some test cases that depend on
2556 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2557 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002558 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002559 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002560
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002561 # Note: the next two invocations cover all compat.sh test cases.
2562 # We should use the same here and in basic-build-test.sh.
2563 msg "test: compat.sh: default version (full minus PSA crypto)"
2564 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002565
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002566 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002567 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002568}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002569
Ronald Cron403c15c2021-09-13 09:38:05 +02002570component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002571 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002572
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002573 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002574 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002575 $(helper_get_psa_key_type_list "ECC") \
2576 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002577
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002578 # Configure
2579 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002580
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002581 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002582 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002583
2584 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002585 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002586
2587 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002588 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2589 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2590
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002591 # Build
2592 # -----
2593
2594 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002595 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2596 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002597
2598 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2599
Valerio Setti3fe105b2023-10-30 11:08:12 +01002600 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002601
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002602 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002603 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002604
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002605 # Run the tests
2606 # -------------
2607
Ronald Cron403c15c2021-09-13 09:38:05 +02002608 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2609 make test
2610}
2611
Valerio Setti44b178c2023-03-22 14:02:57 +01002612component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002613 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002614
2615 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002616 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002617 $(helper_get_psa_key_type_list "ECC") \
2618 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002619
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002620 # Configure
2621 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002622
Ronald Cron46ac0652024-03-18 12:39:04 +01002623 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002624 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002625
Valerio Setti44b178c2023-03-22 14:02:57 +01002626 # Disable the module that's accelerated
2627 scripts/config.py unset MBEDTLS_ECDH_C
2628
2629 # Disable things that depend on it
2630 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2631 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2632 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2633 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2634 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2635
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002636 # Build
2637 # -----
2638
2639 helper_libtestdriver1_make_drivers "$loc_accel_list"
2640
Valerio Setti3fe105b2023-10-30 11:08:12 +01002641 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002642
Valerio Setti44b178c2023-03-22 14:02:57 +01002643 # Make sure this was not re-enabled by accident (additive config)
2644 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002645
2646 # Run the tests
2647 # -------------
2648
Valerio Setti44b178c2023-03-22 14:02:57 +01002649 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002650 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002651}
2652
Przemek Stekieldccb2022023-05-11 10:48:50 +02002653component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002654 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002655
2656 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002657 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002658 $(helper_get_psa_key_type_list "DH") \
2659 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002660
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002661 # Configure
2662 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002663
Przemek Stekiel565353e2023-07-05 11:07:07 +02002664 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002665 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002666
2667 # Disable the module that's accelerated
2668 scripts/config.py unset MBEDTLS_DHM_C
2669
2670 # Disable things that depend on it
2671 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2672 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2673
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002674 # Build
2675 # -----
2676
2677 helper_libtestdriver1_make_drivers "$loc_accel_list"
2678
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002679 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002680
2681 # Make sure this was not re-enabled by accident (additive config)
2682 not grep mbedtls_dhm_ library/dhm.o
2683
2684 # Run the tests
2685 # -------------
2686
Gilles Peskine14302ed2023-07-19 19:30:04 +02002687 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002688 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002689
Gilles Peskine14302ed2023-07-19 19:30:04 +02002690 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002691 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002692}
2693
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002694component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002695 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002696
2697 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002698 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002699
2700 # Disable things that are not supported
2701 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2702 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002703 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002704
Gilles Peskine14302ed2023-07-19 19:30:04 +02002705 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002706 make test
2707
Gilles Peskine14302ed2023-07-19 19:30:04 +02002708 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002709 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002710}
2711
Valerio Setti44b178c2023-03-22 14:02:57 +01002712component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002713 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002714
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002715 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002716 $(helper_get_psa_key_type_list "ECC") \
2717 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002718
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002719 # Configure
2720 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002721
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002722 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002723
2724 # Make built-in fallback not available
2725 scripts/config.py unset MBEDTLS_ECJPAKE_C
2726 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2727
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002728 # Build
2729 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002730
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002731 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002732
Valerio Setti3fe105b2023-10-30 11:08:12 +01002733 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002734
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002735 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002736 not grep mbedtls_ecjpake_init library/ecjpake.o
2737
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002738 # Run the tests
2739 # -------------
2740
Gilles Peskine14302ed2023-07-19 19:30:04 +02002741 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002742 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002743}
2744
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002745component_test_psa_crypto_config_accel_ecc_some_key_types () {
2746 msg "build: full with accelerated EC algs and some key types"
2747
2748 # Algorithms and key types to accelerate
2749 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2750 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2751 ALG_ECDH \
2752 ALG_JPAKE \
2753 KEY_TYPE_ECC_PUBLIC_KEY \
2754 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2755 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002756 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2757 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002758
2759 # Configure
2760 # ---------
2761
2762 # start with config full for maximum coverage (also enables USE_PSA)
2763 helper_libtestdriver1_adjust_config "full"
2764
2765 # Disable modules that are accelerated - some will be re-enabled
2766 scripts/config.py unset MBEDTLS_ECDSA_C
2767 scripts/config.py unset MBEDTLS_ECDH_C
2768 scripts/config.py unset MBEDTLS_ECJPAKE_C
2769 scripts/config.py unset MBEDTLS_ECP_C
2770
2771 # Disable all curves - those that aren't accelerated should be re-enabled
2772 helper_disable_builtin_curves
2773
2774 # Restartable feature is not yet supported by PSA. Once it will in
2775 # the future, the following line could be removed (see issues
2776 # 6061, 6332 and following ones)
2777 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2778
2779 # this is not supported by the driver API yet
2780 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2781
2782 # Build
2783 # -----
2784
2785 # These hashes are needed for some ECDSA signature tests.
2786 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2787 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2788 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2789
Valerio Setti3fe105b2023-10-30 11:08:12 +01002790 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002791
2792 # ECP should be re-enabled but not the others
2793 not grep mbedtls_ecdh_ library/ecdh.o
2794 not grep mbedtls_ecdsa library/ecdsa.o
2795 not grep mbedtls_ecjpake library/ecjpake.o
2796 grep mbedtls_ecp library/ecp.o
2797
2798 # Run the tests
2799 # -------------
2800
2801 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002802 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002803}
2804
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002805# Run tests with only (non-)Weierstrass accelerated
2806# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002807# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2808# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002809common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002810 weierstrass=$1
2811 if [ $weierstrass -eq 1 ]; then
2812 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002813 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002814 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002815 fi
2816
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002817 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002818
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002819 # Note: Curves are handled in a special way by the libtestdriver machinery,
2820 # so we only want to include them in the accel list when building the main
2821 # libraries, hence the use of a separate variable.
2822 # Note: the following loop is a modified version of
2823 # helper_get_psa_curve_list that only keeps Weierstrass families.
2824 loc_weierstrass_list=""
2825 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002826 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2827 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002828 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002829 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002830 ;;
2831 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002832 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002833 ;;
2834 esac
2835 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002836 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002837 loc_curve_list=$loc_weierstrass_list
2838 else
2839 loc_curve_list=$loc_non_weierstrass_list
2840 fi
2841
Valerio Setti3fe105b2023-10-30 11:08:12 +01002842 # Algorithms and key types to accelerate
2843 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2844 ALG_ECDH \
2845 ALG_JPAKE \
2846 $(helper_get_psa_key_type_list "ECC") \
2847 $loc_curve_list"
2848
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002849 # Configure
2850 # ---------
2851
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002852 # Start with config crypto_full and remove PK_C:
2853 # that's what's supported now, see docs/driver-only-builds.md.
2854 helper_libtestdriver1_adjust_config "crypto_full"
2855 scripts/config.py unset MBEDTLS_PK_C
2856 scripts/config.py unset MBEDTLS_PK_PARSE_C
2857 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002858
2859 # Disable modules that are accelerated - some will be re-enabled
2860 scripts/config.py unset MBEDTLS_ECDSA_C
2861 scripts/config.py unset MBEDTLS_ECDH_C
2862 scripts/config.py unset MBEDTLS_ECJPAKE_C
2863 scripts/config.py unset MBEDTLS_ECP_C
2864
2865 # Disable all curves - those that aren't accelerated should be re-enabled
2866 helper_disable_builtin_curves
2867
2868 # Restartable feature is not yet supported by PSA. Once it will in
2869 # the future, the following line could be removed (see issues
2870 # 6061, 6332 and following ones)
2871 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2872
2873 # this is not supported by the driver API yet
2874 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2875
2876 # Build
2877 # -----
2878
2879 # These hashes are needed for some ECDSA signature tests.
2880 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2881 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2882 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2883
Valerio Settiac7a8092023-10-31 12:23:44 +01002884 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002885
2886 # We expect ECDH to be re-enabled for the missing curves
2887 grep mbedtls_ecdh_ library/ecdh.o
2888 # We expect ECP to be re-enabled, however the parts specific to the
2889 # families of curves that are accelerated should be ommited.
2890 # - functions with mxz in the name are specific to Montgomery curves
2891 # - ecp_muladd is specific to Weierstrass curves
2892 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002893 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002894 not grep mbedtls_ecp_muladd library/ecp.o
2895 grep mxz library/ecp.o
2896 else
2897 grep mbedtls_ecp_muladd library/ecp.o
2898 not grep mxz library/ecp.o
2899 fi
2900 # We expect ECDSA and ECJPAKE to be re-enabled only when
2901 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002902 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002903 not grep mbedtls_ecdsa library/ecdsa.o
2904 not grep mbedtls_ecjpake library/ecjpake.o
2905 else
2906 grep mbedtls_ecdsa library/ecdsa.o
2907 grep mbedtls_ecjpake library/ecjpake.o
2908 fi
2909
2910 # Run the tests
2911 # -------------
2912
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002913 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2914 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002915}
2916
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002917component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002918 common_test_psa_crypto_config_accel_ecc_some_curves 1
2919}
2920
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002921component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002922 common_test_psa_crypto_config_accel_ecc_some_curves 0
2923}
2924
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002925# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2926# ECDH, ECDSA) with and without drivers.
2927# The input parameter is a boolean value which indicates:
2928# - 0 keep built-in EC algs,
2929# - 1 exclude built-in EC algs (driver only).
2930#
2931# This is used by the two following components to ensure they always use the
2932# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002933# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2934# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002935# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002936config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002937 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002938 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002939 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002940 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002941 # Disable modules that are accelerated
2942 scripts/config.py unset MBEDTLS_ECDSA_C
2943 scripts/config.py unset MBEDTLS_ECDH_C
2944 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002945 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002946 fi
2947
2948 # Restartable feature is not yet supported by PSA. Once it will in
2949 # the future, the following line could be removed (see issues
2950 # 6061, 6332 and following ones)
2951 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002952}
2953
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002954# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2955component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002956 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002957
2958 # Algorithms and key types to accelerate
2959 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2960 ALG_ECDH \
2961 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002962 $(helper_get_psa_key_type_list "ECC") \
2963 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002964
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002965 # Configure
2966 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002967
2968 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002969 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002970
Valerio Setti0a342c92023-09-01 09:12:31 +02002971 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002972 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2973 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002974
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002975 # Build
2976 # -----
2977
2978 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002979 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2980 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002981 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2982
Valerio Setti3fe105b2023-10-30 11:08:12 +01002983 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002984
2985 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2986 not grep mbedtls_ecdsa_ library/ecdsa.o
2987 not grep mbedtls_ecdh_ library/ecdh.o
2988 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002989 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002990
2991 # Run the tests
2992 # -------------
2993
Gilles Peskine14302ed2023-07-19 19:30:04 +02002994 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002995 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002996
Gilles Peskine14302ed2023-07-19 19:30:04 +02002997 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002998 tests/ssl-opt.sh
2999}
3000
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003001# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3002component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003003 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003004
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003005 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003006
Gilles Peskine21570cf2023-12-22 11:49:50 +01003007 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003008
Gilles Peskine14302ed2023-07-19 19:30:04 +02003009 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003010 make test
3011
Gilles Peskine14302ed2023-07-19 19:30:04 +02003012 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003013 tests/ssl-opt.sh
3014}
3015
Valerio Settie618cb02023-04-12 14:59:16 +02003016# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003017# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3018# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003019# to ensure that both tests use the same underlying configuration when testing
3020# driver's coverage with analyze_outcomes.py.
3021#
3022# This functions accepts 1 boolean parameter as follows:
3023# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3024# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3025# - 0: include built-in implementation of EC algorithms.
3026#
3027# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3028# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003029config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003030 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003031 # start with full config for maximum coverage (also enables USE_PSA)
3032 helper_libtestdriver1_adjust_config "full"
3033
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003034 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003035 # Disable modules that are accelerated
3036 scripts/config.py unset MBEDTLS_ECDSA_C
3037 scripts/config.py unset MBEDTLS_ECDH_C
3038 scripts/config.py unset MBEDTLS_ECJPAKE_C
3039 # Disable ECP module (entirely)
3040 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003041 fi
3042
Valerio Settiaecd32c2023-06-14 10:42:31 +02003043 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3044 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003045 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003046 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003047
Valerio Settie618cb02023-04-12 14:59:16 +02003048 # Restartable feature is not yet supported by PSA. Once it will in
3049 # the future, the following line could be removed (see issues
3050 # 6061, 6332 and following ones)
3051 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003052}
3053
3054# Build and test a configuration where driver accelerates all EC algs while
3055# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3056# side.
3057#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003058# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3059component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003060 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003061
3062 # Algorithms and key types to accelerate
3063 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3064 ALG_ECDH \
3065 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003066 $(helper_get_psa_key_type_list "ECC") \
3067 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003068
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003069 # Configure
3070 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003071
Valerio Settie618cb02023-04-12 14:59:16 +02003072 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003073 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003074 # Disable all the builtin curves. All the required algs are accelerated.
3075 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003076
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003077 # Build
3078 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003079
3080 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003081 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3082 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3083 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003084
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003085 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003086
Valerio Setti3fe105b2023-10-30 11:08:12 +01003087 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003088
3089 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3090 not grep mbedtls_ecdsa_ library/ecdsa.o
3091 not grep mbedtls_ecdh_ library/ecdh.o
3092 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003093 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003094 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003095
3096 # Run the tests
3097 # -------------
3098
Gilles Peskine14302ed2023-07-19 19:30:04 +02003099 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003100 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003101
Gilles Peskine14302ed2023-07-19 19:30:04 +02003102 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003103 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003104}
3105
3106# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003107# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003108# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003109component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003110 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003111
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003112 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003113
Gilles Peskine21570cf2023-12-22 11:49:50 +01003114 make
Valerio Settie618cb02023-04-12 14:59:16 +02003115
Gilles Peskine14302ed2023-07-19 19:30:04 +02003116 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003117 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003118
Gilles Peskine14302ed2023-07-19 19:30:04 +02003119 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003120 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003121}
3122
Valerio Setti4e2f2442023-08-15 10:10:26 +02003123# This is a common configuration helper used directly from:
3124# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3125# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3126# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003127# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003128# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003129# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003130# - this is the reference component of the above
3131# - it still disables RSA and FFDH, but it uses builtin EC algs
3132# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3133# - accelerate all EC and FFDH algs, disable only RSA
3134# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3135# - this is the reference component of the above
3136# - it still disables RSA, but it uses builtin EC and FFDH algs
3137#
3138# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003139# $1: a boolean value which states if we are testing an accelerated scenario
3140# or not.
3141# $2: a string value which states which components are tested. Allowed values
3142# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003143config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003144 driver_only="$1"
3145 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003146 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003147 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003148
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003149 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003150 # Disable modules that are accelerated
3151 scripts/config.py unset MBEDTLS_ECDSA_C
3152 scripts/config.py unset MBEDTLS_ECDH_C
3153 scripts/config.py unset MBEDTLS_ECJPAKE_C
3154 # Disable ECP module (entirely)
3155 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003156 # Also disable bignum
3157 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003158 fi
3159
3160 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3161 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3162 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3163 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3164
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003165 # RSA support is intentionally disabled on this test because RSA_C depends
3166 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003167 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3168 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 +02003169 scripts/config.py unset MBEDTLS_RSA_C
3170 scripts/config.py unset MBEDTLS_PKCS1_V15
3171 scripts/config.py unset MBEDTLS_PKCS1_V21
3172 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3173 # Also disable key exchanges that depend on RSA
3174 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3175 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3176 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3177 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3178 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3179
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003180 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003181 # When testing ECC only, we disable FFDH support, both from builtin and
3182 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003183 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003184 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 +01003185 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003186 scripts/config.py unset MBEDTLS_DHM_C
3187 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3188 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3189 else
3190 # When testing ECC and DH instead, we disable DHM and depending key
3191 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003192 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003193 scripts/config.py unset MBEDTLS_DHM_C
3194 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3195 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3196 fi
3197 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003198
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003199 # Restartable feature is not yet supported by PSA. Once it will in
3200 # the future, the following line could be removed (see issues
3201 # 6061, 6332 and following ones)
3202 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3203}
3204
Valerio Setti4e2f2442023-08-15 10:10:26 +02003205# Common helper used by:
3206# - component_test_psa_crypto_config_accel_ecc_no_bignum
3207# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003208#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003209# The goal is to build and test accelerating either:
3210# - ECC only or
3211# - both ECC and FFDH
3212#
3213# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003214# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3215# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003216common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003217 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003218
Valerio Setti5dfaca42023-09-05 08:48:51 +02003219 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003220 if [ "$test_target" = "ECC_DH" ]; then
3221 accel_text="ECC/FFDH"
3222 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003223 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003224 accel_text="ECC"
3225 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003226 fi
3227
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003228 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003229
3230 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003231 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3232 ALG_ECDH \
3233 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003234 $(helper_get_psa_key_type_list "ECC") \
3235 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003236 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003237 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003238 loc_accel_list="$loc_accel_list \
3239 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003240 $(helper_get_psa_key_type_list "DH") \
3241 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003242 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003243
3244 # Configure
3245 # ---------
3246
3247 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003248 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003249 # Disable all the builtin curves. All the required algs are accelerated.
3250 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003251
3252 # Build
3253 # -----
3254
3255 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003256 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3257 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3258 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003259
3260 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3261
Valerio Setti3fe105b2023-10-30 11:08:12 +01003262 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003263
3264 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3265 not grep mbedtls_ecdsa_ library/ecdsa.o
3266 not grep mbedtls_ecdh_ library/ecdh.o
3267 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003268 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003269 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003270 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003271 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003272 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003273
3274 # Run the tests
3275 # -------------
3276
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003277 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003278
Gilles Peskine21570cf2023-12-22 11:49:50 +01003279 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003280
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003281 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003282 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003283}
3284
Valerio Setti4e2f2442023-08-15 10:10:26 +02003285# Common helper used by:
3286# - component_test_psa_crypto_config_reference_ecc_no_bignum
3287# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3288#
3289# The goal is to build and test a reference scenario (i.e. with builtin
3290# components) compared to the ones used in
3291# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3292#
3293# It is meant to be used in conjunction with
3294# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3295# coverage analysis in "analyze_outcomes.py" script.
3296common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003297 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003298
Valerio Setti5dfaca42023-09-05 08:48:51 +02003299 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003300 if [ "$test_target" = "ECC_DH" ]; then
3301 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003302 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003303 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003304 fi
3305
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003306 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003307
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003308 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003309
Gilles Peskine21570cf2023-12-22 11:49:50 +01003310 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003311
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003312 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003313 make test
3314
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003315 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003316 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003317}
3318
Valerio Setti4e2f2442023-08-15 10:10:26 +02003319component_test_psa_crypto_config_accel_ecc_no_bignum () {
3320 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3321}
3322
3323component_test_psa_crypto_config_reference_ecc_no_bignum () {
3324 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3325}
3326
3327component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3328 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3329}
3330
3331component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3332 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3333}
3334
Valerio Settiac6d35f2023-08-04 12:49:11 +02003335# Helper for setting common configurations between:
3336# - component_test_tfm_config_p256m_driver_accel_ec()
3337# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003338common_tfm_config () {
3339 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003340 cp configs/config-tfm.h "$CONFIG_H"
3341 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3342 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003343
Yanray Wang73bb2312023-09-25 11:21:15 +08003344 # Other config adjustment to make the tests pass.
3345 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003346 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003347 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3348 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003349
Yanray Wang73bb2312023-09-25 11:21:15 +08003350 # Config adjustment for better test coverage in our environment.
3351 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003352 #
3353 # Enable filesystem I/O for the benefit of PK parse/write tests.
3354 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3355}
3356
Valerio Settiac6d35f2023-08-04 12:49:11 +02003357# Keep this in sync with component_test_tfm_config() as they are both meant
3358# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003359component_test_tfm_config_p256m_driver_accel_ec () {
3360 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3361
3362 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003363
Dave Rodgman897bb772023-11-15 16:34:20 +00003364 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003365 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003366
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003367 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3368 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003369 not grep mbedtls_ecdh_ library/ecdh.o
3370 not grep mbedtls_ecjpake_ library/ecjpake.o
3371 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3372 not grep mbedtls_ecp_ library/ecp.o
3373 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003374 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003375 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003376 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003377 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003378
Valerio Setti5e18b902023-12-04 12:07:30 +01003379 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3380 # files, so we want to ensure that it has not be re-enabled accidentally.
3381 not grep mbedtls_cipher library/cipher.o
3382
Valerio Settib7e95442023-03-21 11:52:33 +01003383 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003384 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003385 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003386}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003387
Valerio Settiac6d35f2023-08-04 12:49:11 +02003388# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3389# they are both meant to be used in analyze_outcomes.py for driver's coverage
3390# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003391component_test_tfm_config() {
3392 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003393
Dave Rodgman897bb772023-11-15 16:34:20 +00003394 # Disable P256M driver, which is on by default, so that analyze_outcomes
3395 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3396 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3397
Valerio Setti52ba0e32023-08-04 12:43:03 +02003398 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003399 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003400
Dave Rodgman897bb772023-11-15 16:34:20 +00003401 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003402 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003403
Valerio Setti5e18b902023-12-04 12:07:30 +01003404 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3405 # files, so we want to ensure that it has not be re-enabled accidentally.
3406 not grep mbedtls_cipher library/cipher.o
3407
Valerio Setti52ba0e32023-08-04 12:43:03 +02003408 msg "test: TF-M config"
3409 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003410}
3411
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003412# Common helper for component_full_without_ecdhe_ecdsa() and
3413# component_full_without_ecdhe_ecdsa_and_tls13() which:
3414# - starts from the "full" configuration minus the list of symbols passed in
3415# as 1st parameter
3416# - build
3417# - test only TLS (i.e. test_suite_tls and ssl-opt)
3418build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003419 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003420
3421 msg "build: full minus something, test TLS"
3422
3423 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003424 for sym in $symbols_to_disable; do
3425 echo "Disabling $sym"
3426 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003427 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003428
Gilles Peskine21570cf2023-12-22 11:49:50 +01003429 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003430
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003431 msg "test: full minus something, test TLS"
3432 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003433
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003434 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003435 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003436}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003437
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003438component_full_without_ecdhe_ecdsa () {
3439 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003440}
3441
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003442component_full_without_ecdhe_ecdsa_and_tls13 () {
3443 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3444 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003445}
3446
Valerio Setti249b18a2023-06-20 12:08:30 +02003447# This is an helper used by:
3448# - component_test_psa_ecc_key_pair_no_derive
3449# - component_test_psa_ecc_key_pair_no_generate
3450# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3451# enabled, but one. Input arguments are as follows:
3452# - $1 is the key type under test, i.e. ECC/RSA/DH
3453# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003454build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003455 key_type=$1
3456 unset_option=$2
3457 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003458
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003459 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003460 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003461 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3462 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3463
3464 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3465 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003466 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003467
Gilles Peskine21570cf2023-12-22 11:49:50 +01003468 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003469
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003470 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003471 make test
3472}
3473
3474component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003475 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003476}
3477
3478component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003479 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003480}
3481
Pengyu Lve705f572023-12-06 16:38:15 +08003482config_psa_crypto_accel_rsa () {
3483 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003484
Pengyu Lve705f572023-12-06 16:38:15 +08003485 # Start from crypto_full config (no X.509, no TLS)
3486 helper_libtestdriver1_adjust_config "crypto_full"
3487
3488 if [ "$driver_only" -eq 1 ]; then
3489 # Remove RSA support and its dependencies
3490 scripts/config.py unset MBEDTLS_RSA_C
3491 scripts/config.py unset MBEDTLS_PKCS1_V15
3492 scripts/config.py unset MBEDTLS_PKCS1_V21
3493
3494 # We need PEM parsing in the test library as well to support the import
3495 # of PEM encoded RSA keys.
3496 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3497 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3498 fi
3499}
3500
3501component_test_psa_crypto_config_accel_rsa_crypto () {
3502 msg "build: crypto_full with accelerated RSA"
3503
3504 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3505 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3506 KEY_TYPE_RSA_PUBLIC_KEY \
3507 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3508 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3509 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3510 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003511
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003512 # Configure
3513 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003514
Pengyu Lve705f572023-12-06 16:38:15 +08003515 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003516
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003517 # Build
3518 # -----
3519
Pengyu Lve705f572023-12-06 16:38:15 +08003520 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003521 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 +08003522 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003523 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003524
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003525 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003526
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003527 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003528 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003529
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003530 # Run the tests
3531 # -------------
3532
Pengyu Lve705f572023-12-06 16:38:15 +08003533 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003534 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003535}
3536
3537component_test_psa_crypto_config_reference_rsa_crypto () {
3538 msg "build: crypto_full with non-accelerated RSA"
3539
3540 # Configure
3541 # ---------
3542 config_psa_crypto_accel_rsa 0
3543
3544 # Build
3545 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003546 make
Pengyu Lve705f572023-12-06 16:38:15 +08003547
3548 # Run the tests
3549 # -------------
3550 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003551 make test
3552}
3553
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003554# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003555# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003556component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003557 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003558
Valerio Setti4590bc22023-06-13 15:39:23 +02003559 # Create a temporary output file unless there is already one set
3560 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3561 REMOVE_OUTCOME_ON_EXIT="no"
3562 else
3563 REMOVE_OUTCOME_ON_EXIT="yes"
3564 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3565 export MBEDTLS_TEST_OUTCOME_FILE
3566 fi
3567
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003568 # Start from crypto configuration
3569 scripts/config.py crypto
3570
3571 # Remove RSA support and its dependencies
3572 scripts/config.py unset MBEDTLS_PKCS1_V15
3573 scripts/config.py unset MBEDTLS_PKCS1_V21
3574 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3575 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3576 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3577 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3578 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3579 scripts/config.py unset MBEDTLS_RSA_C
3580 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3581
3582 # Enable PSA support
3583 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3584
Valerio Setti01cc88a2023-06-15 11:53:08 +02003585 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003586 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003587 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3588 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3589 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003590
3591 make
3592
Valerio Setti01cc88a2023-06-15 11:53:08 +02003593 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003594 make test
3595
3596 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3597 # performing RSA signature.
3598 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3599 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3600
3601 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3602 rm $MBEDTLS_TEST_OUTCOME_FILE
3603 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003604}
3605
Ronald Cronb2312452021-05-08 14:32:59 +02003606component_test_psa_crypto_config_accel_hash () {
3607 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3608
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003609 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3610 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3611 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003612
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003613 # Configure
3614 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003615
Ronald Cron46ac0652024-03-18 12:39:04 +01003616 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003617 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003618
3619 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003620 scripts/config.py unset MBEDTLS_MD5_C
3621 scripts/config.py unset MBEDTLS_RIPEMD160_C
3622 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003623 scripts/config.py unset MBEDTLS_SHA224_C
3624 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003625 scripts/config.py unset MBEDTLS_SHA384_C
3626 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003627 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003628
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003629 # Build
3630 # -----
3631
3632 helper_libtestdriver1_make_drivers "$loc_accel_list"
3633
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003634 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003635
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003636 # There's a risk of something getting re-enabled via config_psa.h;
3637 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3638 not grep mbedtls_md5 library/md5.o
3639 not grep mbedtls_sha1 library/sha1.o
3640 not grep mbedtls_sha256 library/sha256.o
3641 not grep mbedtls_sha512 library/sha512.o
3642 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003643
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003644 # Run the tests
3645 # -------------
3646
Ronald Cronb2312452021-05-08 14:32:59 +02003647 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3648 make test
3649}
3650
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003651# Auxiliary function to build config for hashes with and without drivers
3652config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003653 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003654 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003655 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003656 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003657 # disable the built-in implementation of hashes
3658 scripts/config.py unset MBEDTLS_MD5_C
3659 scripts/config.py unset MBEDTLS_RIPEMD160_C
3660 scripts/config.py unset MBEDTLS_SHA1_C
3661 scripts/config.py unset MBEDTLS_SHA224_C
3662 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003663 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003664 scripts/config.py unset MBEDTLS_SHA384_C
3665 scripts/config.py unset MBEDTLS_SHA512_C
3666 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003667 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003668 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003669}
3670
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003671# Note that component_test_psa_crypto_config_reference_hash_use_psa
3672# is related to this component and both components need to be kept in sync.
3673# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003674component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003675 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003676
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003677 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3678 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3679 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003680
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003681 # Configure
3682 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003683
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003684 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003685
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003686 # Build
3687 # -----
3688
3689 helper_libtestdriver1_make_drivers "$loc_accel_list"
3690
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003691 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003692
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003693 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003694 # 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 +02003695 not grep mbedtls_md5 library/md5.o
3696 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003697 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003698 not grep mbedtls_sha512 library/sha512.o
3699 not grep mbedtls_ripemd160 library/ripemd160.o
3700
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003701 # Run the tests
3702 # -------------
3703
Gilles Peskine14302ed2023-07-19 19:30:04 +02003704 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003705 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003706
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003707 # This is mostly useful so that we can later compare outcome files with
3708 # the reference config in analyze_outcomes.py, to check that the
3709 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003710 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003711 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003712
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003713 # This is to make sure all ciphersuites are exercised, but we don't need
3714 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003715 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003716 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003717}
3718
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003719# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3720# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3721# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3722# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003723component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003724 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003725
3726 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003727
Gilles Peskine21570cf2023-12-22 11:49:50 +01003728 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003729
Gilles Peskine14302ed2023-07-19 19:30:04 +02003730 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003731 make test
3732
Gilles Peskine14302ed2023-07-19 19:30:04 +02003733 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003734 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003735}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003736
Valerio Setti8eb310c2024-01-22 16:22:57 +01003737# Auxiliary function to build config for hashes with and without drivers
3738config_psa_crypto_hmac_use_psa () {
3739 driver_only="$1"
3740 # start with config full for maximum coverage (also enables USE_PSA)
3741 helper_libtestdriver1_adjust_config "full"
3742
Valerio Setticd89b0b2024-01-24 14:24:55 +01003743 if [ "$driver_only" -eq 1 ]; then
3744 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3745 # is still enabled though (for ENTROPY_C among others).
3746 scripts/config.py unset MBEDTLS_MD_C
3747 # Disable also the builtin hashes since they are supported by the driver
3748 # and MD module is able to perform PSA dispathing.
3749 scripts/config.py unset-all MBEDTLS_SHA
3750 scripts/config.py unset MBEDTLS_MD5_C
3751 scripts/config.py unset MBEDTLS_RIPEMD160_C
3752 fi
3753
Valerio Setti8eb310c2024-01-22 16:22:57 +01003754 # Direct dependencies of MD_C. We disable them also in the reference
3755 # component to work with the same set of features.
3756 scripts/config.py unset MBEDTLS_PKCS7_C
3757 scripts/config.py unset MBEDTLS_PKCS5_C
3758 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3759 scripts/config.py unset MBEDTLS_HKDF_C
3760 # Dependencies of HMAC_DRBG
3761 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3762 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3763}
3764
3765component_test_psa_crypto_config_accel_hmac() {
3766 msg "test: full with accelerated hmac"
3767
3768 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3769 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3770 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3771 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3772
3773 # Configure
3774 # ---------
3775
3776 config_psa_crypto_hmac_use_psa 1
3777
Valerio Setti8eb310c2024-01-22 16:22:57 +01003778 # Build
3779 # -----
3780
3781 helper_libtestdriver1_make_drivers "$loc_accel_list"
3782
3783 helper_libtestdriver1_make_main "$loc_accel_list"
3784
3785 # Ensure that built-in support for HMAC is disabled.
3786 not grep mbedtls_md_hmac library/md.o
3787
3788 # Run the tests
3789 # -------------
3790
3791 msg "test: full with accelerated hmac"
3792 make test
3793}
3794
3795component_test_psa_crypto_config_reference_hmac() {
3796 msg "test: full without accelerated hmac"
3797
3798 config_psa_crypto_hmac_use_psa 0
3799
3800 make
3801
3802 msg "test: full without accelerated hmac"
3803 make test
3804}
3805
Valerio Setti9da01a72023-12-18 17:38:18 +01003806component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003807 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003808
Valerio Setti9da01a72023-12-18 17:38:18 +01003809 # Albeit this components aims at accelerating DES which should only support
3810 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3811 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003812 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3813 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3814 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003815
Valerio Setti9da01a72023-12-18 17:38:18 +01003816 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3817 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3818 # of this component. This limitation will be addressed by #8598.
3819
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003820 # Configure
3821 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003822
Valerio Setti9a427302023-10-17 11:40:42 +02003823 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003824 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003825
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003826 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003827 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3828 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3829 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3830 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3831 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3832 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3833 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003834 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003835
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003836 # Build
3837 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003838
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003839 helper_libtestdriver1_make_drivers "$loc_accel_list"
3840
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003841 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003842
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003843 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003844 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003845
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003846 # Run the tests
3847 # -------------
3848
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003849 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003850 make test
3851}
3852
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003853component_test_psa_crypto_config_accel_aead () {
3854 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3855
Valerio Setti3f02bb72023-10-02 15:57:33 +02003856 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3857 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003858
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003859 # Configure
3860 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003861
Valerio Setti3f02bb72023-10-02 15:57:33 +02003862 # Start from full config
3863 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003864
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003865 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003866 scripts/config.py unset MBEDTLS_GCM_C
3867 scripts/config.py unset MBEDTLS_CCM_C
3868 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003869
Valerio Settia50b89e2023-11-08 15:58:47 +01003870 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3871 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003872
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003873 # Build
3874 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003875
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003876 helper_libtestdriver1_make_drivers "$loc_accel_list"
3877
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003878 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003879
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003880 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003881 not grep mbedtls_ccm library/ccm.o
3882 not grep mbedtls_gcm library/gcm.o
3883 not grep mbedtls_chachapoly library/chachapoly.o
3884
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003885 # Run the tests
3886 # -------------
3887
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003888 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3889 make test
3890}
3891
Valerio Settib680fc42023-10-13 09:29:37 +02003892# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003893# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3894# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3895common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003896 # Start from the full config
3897 helper_libtestdriver1_adjust_config "full"
3898
Valerio Settib680fc42023-10-13 09:29:37 +02003899 scripts/config.py unset MBEDTLS_NIST_KW_C
3900}
3901
Valerio Settib6b301f2023-10-04 12:05:05 +02003902# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003903# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3904# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003905# are meant to be used together in analyze_outcomes.py script in order to test
3906# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003907component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3908 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003909
Valerio Settiad8b7f02023-10-25 12:39:50 +02003910 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 +01003911 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003912 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003913 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3914
3915 # Configure
3916 # ---------
3917
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003918 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003919
3920 # Disable the things that are being accelerated
3921 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3922 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3923 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3924 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3925 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3926 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3927 scripts/config.py unset MBEDTLS_GCM_C
3928 scripts/config.py unset MBEDTLS_CCM_C
3929 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003930 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003931 scripts/config.py unset MBEDTLS_DES_C
3932 scripts/config.py unset MBEDTLS_AES_C
3933 scripts/config.py unset MBEDTLS_ARIA_C
3934 scripts/config.py unset MBEDTLS_CHACHA20_C
3935 scripts/config.py unset MBEDTLS_CAMELLIA_C
3936
Valerio Settiec9b2582023-11-08 16:50:54 +01003937 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3938 # does not depend on it.
3939 scripts/config.py unset MBEDTLS_CIPHER_C
3940
Valerio Settib6b301f2023-10-04 12:05:05 +02003941 # Build
3942 # -----
3943
3944 helper_libtestdriver1_make_drivers "$loc_accel_list"
3945
3946 helper_libtestdriver1_make_main "$loc_accel_list"
3947
3948 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003949 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003950 not grep mbedtls_des library/des.o
3951 not grep mbedtls_aes library/aes.o
3952 not grep mbedtls_aria library/aria.o
3953 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003954 not grep mbedtls_ccm library/ccm.o
3955 not grep mbedtls_gcm library/gcm.o
3956 not grep mbedtls_chachapoly library/chachapoly.o
3957 not grep mbedtls_cmac library/cmac.o
3958
3959 # Run the tests
3960 # -------------
3961
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003962 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003963 make test
Valerio Settif9414552023-11-09 10:43:20 +01003964
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003965 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003966 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003967
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003968 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003969 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003970}
3971
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003972component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3973 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3974 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003975
Gilles Peskine21570cf2023-12-22 11:49:50 +01003976 make
Valerio Settif9414552023-11-09 10:43:20 +01003977
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003978 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003979 make test
Valerio Settif9414552023-11-09 10:43:20 +01003980
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003981 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003982 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003983
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003984 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003985 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003986}
3987
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003988common_block_cipher_dispatch() {
3989 TEST_WITH_DRIVER="$1"
3990
3991 # Start from the full config
3992 helper_libtestdriver1_adjust_config "full"
3993
3994 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3995 # Disable key types that are accelerated (there is no legacy equivalent
3996 # symbol for ECB)
3997 scripts/config.py unset MBEDTLS_AES_C
3998 scripts/config.py unset MBEDTLS_ARIA_C
3999 scripts/config.py unset MBEDTLS_CAMELLIA_C
4000 fi
4001
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004002 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004003 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004004 # Keep this also in the reference component in order to skip the same tests
4005 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004006 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4007 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4008 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4009 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4010 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4011 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4012 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02004013 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004014
4015 # Disable direct dependency on AES_C
4016 scripts/config.py unset MBEDTLS_NIST_KW_C
4017
4018 # Prevent the cipher module from using deprecated PSA path. The reason is
4019 # that otherwise there will be tests relying on "aes_info" (defined in
4020 # "cipher_wrap.c") whose functions are not available when AES_C is
4021 # not defined. ARIA and Camellia are not a problem in this case because
4022 # the PSA path is not tested for these key types.
4023 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4024}
4025
Valerio Settif8e6cba2023-12-12 11:53:39 +01004026component_test_full_block_cipher_psa_dispatch () {
4027 msg "build: full + PSA dispatch in block_cipher"
4028
4029 loc_accel_list="ALG_ECB_NO_PADDING \
4030 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4031
4032 # Configure
4033 # ---------
4034
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004035 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004036
Valerio Settif8e6cba2023-12-12 11:53:39 +01004037 # Build
4038 # -----
4039
4040 helper_libtestdriver1_make_drivers "$loc_accel_list"
4041
4042 helper_libtestdriver1_make_main "$loc_accel_list"
4043
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004044 # Make sure disabled components were not re-enabled by accident (additive
4045 # config)
4046 not grep mbedtls_aes_ library/aes.o
4047 not grep mbedtls_aria_ library/aria.o
4048 not grep mbedtls_camellia_ library/camellia.o
4049
Valerio Settif8e6cba2023-12-12 11:53:39 +01004050 # Run the tests
4051 # -------------
4052
4053 msg "test: full + PSA dispatch in block_cipher"
4054 make test
4055}
4056
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004057# This is the reference component of component_test_full_block_cipher_psa_dispatch
4058component_test_full_block_cipher_legacy_dispatch () {
4059 msg "build: full + legacy dispatch in block_cipher"
4060
4061 common_block_cipher_dispatch 0
4062
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004063 make
4064
4065 msg "test: full + legacy dispatch in block_cipher"
4066 make test
4067}
4068
Gilles Peskine36dea152023-07-20 22:19:45 +02004069component_test_aead_chachapoly_disabled() {
4070 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004071 scripts/config.py full
4072 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004073 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004074 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004075
Gilles Peskine36dea152023-07-20 22:19:45 +02004076 msg "test: full minus CHACHAPOLY"
4077 make test
4078}
4079
4080component_test_aead_only_ccm() {
4081 msg "build: full minus CHACHAPOLY and GCM"
4082 scripts/config.py full
4083 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4084 scripts/config.py unset MBEDTLS_GCM_C
4085 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4086 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004087 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004088
4089 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004090 make test
4091}
4092
Ronald Crone501d0e2023-07-10 08:31:19 +02004093component_test_ccm_aes_sha256() {
4094 msg "build: CCM + AES + SHA256 configuration"
4095
Ronald Cron7612d8c2023-07-20 10:03:54 +02004096 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004097 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004098
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004099 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004100
4101 msg "test: CCM + AES + SHA256 configuration"
4102 make test
4103}
4104
Dave Rodgman904c5892023-06-28 17:36:02 +01004105support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004106 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004107}
4108
Dave Rodgman904c5892023-06-28 17:36:02 +01004109component_build_tfm_armcc() {
4110 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004111 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004112
Dave Rodgman88651c42023-06-29 12:35:51 +01004113 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004114 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 +01004115}
4116
4117component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004118 # Check that the TF-M configuration can build cleanly with various
4119 # warning flags enabled. We don't build or run tests, since the
4120 # TF-M configuration needs a TF-M platform. A tweaked version of
4121 # the configuration that works on mainstream platforms is in
4122 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004123 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004124
Dave Rodgman88651c42023-06-29 12:35:51 +01004125 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004126 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 +01004127
Dave Rodgman904c5892023-06-28 17:36:02 +01004128 msg "build: TF-M config, gcc native build"
4129 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004130 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 +01004131}
4132
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004133# Test that the given .o file builds with all (valid) combinations of the given options.
4134#
4135# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4136#
4137# The validator function is the name of a function to validate the combination of options.
4138# It may be "" if all combinations are valid.
4139# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004140# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004141build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004142 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004143 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004144 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004145 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004146 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004147
Dave Rodgman42436102023-10-03 15:47:05 +01004148 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004149 for opt in "${options[@]}"; do
4150 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004151 done
4152
4153 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004154 cd $(dirname ${file})
4155 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004156
Dave Rodgman920343a2023-10-01 18:41:09 +01004157 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004158 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 +01004159
Dave Rodgman42436102023-10-03 15:47:05 +01004160 # Extract the command generated by the Makefile to build the target file.
4161 # This ensures that we have any include paths, macro definitions, etc
4162 # that may be applied by make.
4163 # 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 +01004164 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004165
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004166 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004167 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004168
Dave Rodgman28e38d82023-10-04 11:50:30 +01004169 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004170 source_file=${file%.o}.c
4171
4172 targets=0
4173 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004174
Dave Rodgman28e38d82023-10-04 11:50:30 +01004175 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004176 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004177 # each bit of $i is used to determine if options[i] will be set or not
4178 target="t"
4179 clang_args=""
4180 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004181 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004182 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004183 clang_args="${clang_args} ${opt}"
4184 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004185 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004186 done
4187
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004188 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004189 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004190 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004191 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004192
Dave Rodgman28e38d82023-10-04 11:50:30 +01004193 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004194 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004195 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004196 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004197
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004198 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004199
Dave Rodgman920343a2023-10-01 18:41:09 +01004200 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004201 make -s -f ${makefile} build_test_config_combos
4202 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004203
4204 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004205 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004206}
4207
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004208validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004209 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4210 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004211 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004212 fi
4213 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4214 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004215 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004216 fi
4217 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004218 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004219}
4220
4221component_build_aes_variations() {
4222 # 18s - around 90ms per clang invocation on M1 Pro
4223 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004224 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004225 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004226
Yanray Wangbc29aef2023-11-06 11:08:17 +08004227 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004228 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004229
Dave Rodgman42436102023-10-03 15:47:05 +01004230 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004231 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4232 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4233 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4234 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004235
4236 cd "$MBEDTLS_ROOT_DIR"
4237 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4238
Yanray Wang42be1ba2023-11-23 14:28:47 +08004239 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004240 # manually set or unset those configurations to check
4241 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004242 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4243 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4244 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4245 scripts/config.py unset MBEDTLS_DES_C
4246 scripts/config.py unset MBEDTLS_NIST_KW_C
4247 build_test_config_combos library/aes.o validate_aes_config_variations \
4248 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4249 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4250 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4251 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004252}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004253
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004254component_test_no_platform () {
4255 # Full configuration build, without platform support, file IO and net sockets.
4256 # This should catch missing mbedtls_printf definitions, and by disabling file
4257 # IO, it should catch missing '#include <stdio.h>'
4258 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004259 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004260 scripts/config.py unset MBEDTLS_PLATFORM_C
4261 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004262 scripts/config.py unset MBEDTLS_FS_IO
4263 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004264 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004265 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004266 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004267 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004268 # to re-enable platform integration features otherwise disabled in C99 builds
4269 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004270 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004271}
Gilles Peskine7c652162017-12-11 00:01:40 +01004272
4273component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004274 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004275 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4276 scripts/config.py full
4277 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004278 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4279 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4280 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4281 make
4282}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004283
Gilles Peskine8f073122018-11-27 15:58:47 +01004284component_build_no_ssl_srv () {
4285 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004286 scripts/config.py full
4287 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004288 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004289}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004290
Gilles Peskine8f073122018-11-27 15:58:47 +01004291component_build_no_ssl_cli () {
4292 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004293 scripts/config.py full
4294 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004295 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004296}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004297
Gilles Peskine8f073122018-11-27 15:58:47 +01004298component_build_no_sockets () {
4299 # Note, C99 compliance can also be tested with the sockets support disabled,
4300 # as that requires a POSIX platform (which isn't the same as C99).
4301 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004302 scripts/config.py full
4303 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4304 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4305 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4306}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004307
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004308component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004309 msg "build: default config with memory buffer allocator and backtrace enabled"
4310 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4311 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4312 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004313 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004314 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004315 make
4316
4317 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4318 make test
4319}
4320
4321component_test_memory_buffer_allocator () {
4322 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004323 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4324 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004325 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004326 make
4327
4328 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4329 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004330
4331 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4332 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004333 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004334}
4335
Gilles Peskine8f073122018-11-27 15:58:47 +01004336component_test_no_max_fragment_length () {
4337 # Run max fragment length tests with MFL disabled
4338 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004339 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004340 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004341 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004342
Gilles Peskine8f073122018-11-27 15:58:47 +01004343 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004344 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004345}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004346
Hanno Becker545ced42019-02-19 11:10:48 +00004347component_test_asan_remove_peer_certificate () {
4348 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004349 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004350 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004351 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004352 make
4353
4354 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4355 make test
4356
4357 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004358 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004359
4360 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004361 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004362
4363 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004364 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004365}
4366
Gilles Peskine8f073122018-11-27 15:58:47 +01004367component_test_no_max_fragment_length_small_ssl_out_content_len () {
4368 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004369 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4370 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4371 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004372 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004373 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004374
Gilles Peskine8f073122018-11-27 15:58:47 +01004375 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004376 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004377
4378 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004379 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004380}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004381
Darryl Greenaad82f92019-12-02 10:53:11 +00004382component_test_variable_ssl_in_out_buffer_len () {
4383 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4384 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004385 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004386 make
4387
4388 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4389 make test
4390
4391 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004392 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004393
4394 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004395 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004396}
4397
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004398component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004399 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004400 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004401
Dave Rodgman17127e92023-12-14 16:42:48 +00004402 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004403 make
4404
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004405 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004406 make test
4407
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004408 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004409 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004410
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004411 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004412 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004413}
4414
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004415component_test_ssl_alloc_buffer_and_mfl () {
4416 msg "build: default config with memory buffer allocator and MFL extension"
4417 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4418 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4419 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4420 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4421 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004422 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004423 make
4424
4425 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4426 make test
4427
4428 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 +02004429 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004430}
4431
Gilles Peskine636c26a2020-03-04 20:46:15 +01004432component_test_when_no_ciphersuites_have_mac () {
4433 msg "build: when no ciphersuites have MAC"
4434 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004435 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004436 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004437 make
4438
4439 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4440 make test
4441
4442 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004443 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004444}
4445
Raoul Strackxa4e86142020-06-15 17:03:13 +02004446component_test_no_date_time () {
4447 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4448 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004449 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004450 make
4451
4452 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4453 make test
4454}
4455
Gilles Peskine8f073122018-11-27 15:58:47 +01004456component_test_platform_calloc_macro () {
4457 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004458 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4459 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4460 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004461 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004462 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004463
Gilles Peskine8f073122018-11-27 15:58:47 +01004464 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4465 make test
4466}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004467
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004468component_test_malloc_0_null () {
4469 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004470 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004471 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 +02004472
4473 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4474 make test
4475
4476 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4477 # Just the calloc selftest. "make test" ran the others as part of the
4478 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004479 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004480
4481 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4482 # Run a subset of the tests. The choice is a balance between coverage
4483 # and time (including time indirectly wasted due to flaky tests).
4484 # The current choice is to skip tests whose description includes
4485 # "proxy", which is an approximation of skipping tests that use the
4486 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004487 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004488}
4489
Dave Rodgman6a08b682023-06-19 11:51:33 +01004490support_test_aesni() {
4491 # Check that gcc targets x86_64 (we can build AESNI), and check for
4492 # AESNI support on the host (we can run AESNI).
4493 #
4494 # The name of this function is possibly slightly misleading, but needs to align
4495 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004496 #
4497 # In principle 32-bit x86 can support AESNI, but our implementation does not
4498 # support 32-bit x86, so we check for x86-64.
4499 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004500 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4501 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004502 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004503}
4504
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004505component_test_aesni () { # ~ 60s
4506 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4507 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4508 #
4509 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4510 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4511 # exercise the plain C impl).
4512
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004513 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004514 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004515 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004516 scripts/config.py set MBEDTLS_HAVE_ASM
4517
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004518 # test the intrinsics implementation
4519 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004520 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004521 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004522 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004523 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004524
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004525 # test the asm implementation
4526 msg "AES tests, test assembly"
4527 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004528 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004529 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004530 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004531
4532 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004533 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004534 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004535 msg "AES tests, plain C"
4536 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004537 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004538 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004539 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004540 not grep -q "AES note: using AESNI" ./programs/test/selftest
4541 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004542
4543 # test the intrinsics implementation
4544 scripts/config.py set MBEDTLS_AESNI_C
4545 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4546 msg "AES tests, test AESNI only"
4547 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004548 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004549 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4550 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004551 grep -q "AES note: using AESNI" ./programs/test/selftest
4552 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004553}
4554
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004555component_test_sha3_variations() {
4556 msg "sha3 loop unroll variations"
4557
4558 # define minimal config sufficient to test SHA3
4559 cat > include/mbedtls/mbedtls_config.h << END
4560 #define MBEDTLS_SELF_TEST
4561 #define MBEDTLS_SHA3_C
4562END
4563
4564 msg "all loops unrolled"
4565 make clean
4566 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"
4567 ./tests/test_suite_shax
4568
4569 msg "all loops rolled up"
4570 make clean
4571 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"
4572 ./tests/test_suite_shax
4573}
4574
Jerry Yub6d39c22023-08-16 15:11:48 +08004575support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004576 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004577}
4578
4579component_test_aesni_m32 () { # ~ 60s
4580 # This tests are duplicated from component_test_aesni for i386 target
4581 #
4582 # AESNI intrinsic code supports i386 and assembly code does not support it.
4583
4584 msg "build: default config with different AES implementations"
4585 scripts/config.py set MBEDTLS_AESNI_C
4586 scripts/config.py set MBEDTLS_PADLOCK_C
4587 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4588 scripts/config.py set MBEDTLS_HAVE_ASM
4589
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004590 # test the intrinsics implementation with gcc
4591 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004592 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004593 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004594 # check that we built intrinsics - this should be used by default when supported by the compiler
4595 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4596 grep -q "AES note: using AESNI" ./programs/test/selftest
4597 grep -q "AES note: built-in implementation." ./programs/test/selftest
4598 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4599 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4600
4601 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004602 scripts/config.py unset MBEDTLS_PADLOCK_C
4603 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4604 msg "AES tests, test AESNI only"
4605 make clean
4606 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4607 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4608 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4609 grep -q "AES note: using AESNI" ./programs/test/selftest
4610 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4611 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4612 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4613}
4614
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004615support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004616 # clang >= 4 is required to build with target attributes
4617 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004618}
4619
4620component_test_aesni_m32_clang() {
4621
4622 scripts/config.py set MBEDTLS_AESNI_C
4623 scripts/config.py set MBEDTLS_PADLOCK_C
4624 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4625 scripts/config.py set MBEDTLS_HAVE_ASM
4626
4627 # test the intrinsics implementation with clang
4628 msg "AES tests, test intrinsics (clang)"
4629 make clean
4630 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4631 # check that we built intrinsics - this should be used by default when supported by the compiler
4632 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4633 grep -q "AES note: using AESNI" ./programs/test/selftest
4634 grep -q "AES note: built-in implementation." ./programs/test/selftest
4635 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4636 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4637}
4638
Jerry Yu193cbc02023-08-03 17:06:29 +08004639# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4640component_build_aes_aesce_armcc () {
4641 msg "Build: AESCE test on arm64 platform without plain C."
4642 scripts/config.py baremetal
4643
4644 # armc[56] don't support SHA-512 intrinsics
4645 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4646
4647 # Stop armclang warning about feature detection for A64_CRYPTO.
4648 # With this enabled, the library does build correctly under armclang,
4649 # but in baremetal builds (as tested here), feature detection is
4650 # unavailable, and the user is notified via a #warning. So enabling
4651 # this feature would prevent us from building with -Werror on
4652 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004653 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004654 scripts/config.py set MBEDTLS_HAVE_ASM
4655
4656 msg "AESCE, build with default configuration."
4657 scripts/config.py set MBEDTLS_AESCE_C
4658 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4659 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4660
4661 msg "AESCE, build AESCE only"
4662 scripts/config.py set MBEDTLS_AESCE_C
4663 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4664 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4665}
4666
Dave Rodgman0c584032023-10-08 12:26:54 +01004667support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004668 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004669 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004670}
4671
4672component_build_aes_armce () {
4673 # Test variations of AES with Armv8 crypto extensions
4674 scripts/config.py set MBEDTLS_AESCE_C
4675 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4676
4677 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004678 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004679
4680 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4681 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4682
4683 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4684 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4685
Dave Rodgman5e419372023-10-23 15:30:20 +01004686 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004687
Dave Rodgman5e419372023-10-23 15:30:20 +01004688 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4689 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004690
Dave Rodgman5e419372023-10-23 15:30:20 +01004691 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4692 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004693
Dave Rodgman5e419372023-10-23 15:30:20 +01004694 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4695 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004696
4697 # test for presence of AES instructions
4698 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4699 msg "clang, test A32 crypto instructions built"
4700 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4701 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4702 msg "clang, test T32 crypto instructions built"
4703 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4704 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4705 msg "clang, test aarch64 crypto instructions built"
4706 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4707 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4708
4709 # test for absence of AES instructions
4710 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4711 scripts/config.py unset MBEDTLS_AESCE_C
4712 msg "clang, test A32 crypto instructions not built"
4713 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4714 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4715 msg "clang, test T32 crypto instructions not built"
4716 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4717 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4718 msg "clang, test aarch64 crypto instructions not built"
4719 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4720 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004721}
4722
Dave Rodgman9ed18532023-10-05 00:06:47 +01004723support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004724 # clang >= 4 is required to build with SHA extensions
4725 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004726}
4727
Dave Rodgmand9e80832023-10-04 17:17:46 +01004728component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004729 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004730
4731
4732 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004733 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004734 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4735 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4736 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4737 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4738 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004739
Dave Rodgmand9e80832023-10-04 17:17:46 +01004740
Dave Rodgman94a634d2023-10-10 12:59:29 +01004741 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004742 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004743 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4744 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4745 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004746
Dave Rodgman5b89c552023-10-10 14:59:02 +01004747 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004748 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4749 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4750 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004751
Dave Rodgmancd654002023-10-05 09:40:07 +01004752
Dave Rodgman94a634d2023-10-10 12:59:29 +01004753 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004754 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004755 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4756 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4757 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4758 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4759 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004760
Dave Rodgmancd654002023-10-05 09:40:07 +01004761
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004762 # examine the disassembly for presence of SHA instructions
4763 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4764 scripts/config.py set ${opt}
4765 msg "${opt} clang, test A32 crypto instructions built"
4766 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4767 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4768
4769 msg "${opt} clang, test T32 crypto instructions built"
4770 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4771 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4772
4773 msg "${opt} clang, test aarch64 crypto instructions built"
4774 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4775 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4776 scripts/config.py unset ${opt}
4777 done
4778
4779
4780 # examine the disassembly for absence of SHA instructions
4781 msg "clang, test A32 crypto instructions not built"
4782 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4783 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4784
4785 msg "clang, test T32 crypto instructions not built"
4786 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4787 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4788
4789 msg "clang, test aarch64 crypto instructions not built"
4790 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4791 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004792}
4793
Jerry Yuc935aa62023-08-03 17:08:27 +08004794# For timebeing, no VIA Padlock platform available.
4795component_build_aes_via_padlock () {
4796
4797 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004798 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004799 scripts/config.py set MBEDTLS_PADLOCK_C
4800 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004801 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004802 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004803
4804}
4805
4806support_build_aes_via_padlock_only () {
4807 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4808 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4809 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4810}
4811
Jerry Yu193cbc02023-08-03 17:06:29 +08004812support_build_aes_aesce_armcc () {
4813 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004814}
4815
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004816component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004817 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004818 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004819 scripts/config.py unset MBEDTLS_PADLOCK_C
4820
Dave Rodgmand8d64512023-12-19 12:20:21 +00004821 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004822
4823 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4824 make test
4825}
4826
4827component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4828 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4829 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004830 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4831 scripts/config.py unset MBEDTLS_PADLOCK_C
4832
Hanno Becker83ebf782017-07-07 12:29:15 +01004833 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004834
4835 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004836 make test
4837}
Gilles Peskine8f073122018-11-27 15:58:47 +01004838
Hanno Becker83ebf782017-07-07 12:29:15 +01004839component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004840 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4841 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4842 scripts/config.py unset MBEDTLS_PADLOCK_C
4843 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004844 scripts/config.py unset MBEDTLS_AESCE_C
4845
Dave Rodgmand8d64512023-12-19 12:20:21 +00004846 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004847
4848 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004849 make test
4850
4851 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4852 programs/test/selftest
4853}
4854
Matthias Schulz0767fda2024-02-07 10:46:28 +01004855component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004856 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4857 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004858 scripts/config.py unset MBEDTLS_PADLOCK_C
4859 scripts/config.py unset MBEDTLS_AESNI_C
4860 scripts/config.py unset MBEDTLS_AESCE_C
4861
4862 make CFLAGS='-O2 -Werror -Wall -Wextra'
4863
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004864 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004865 make test
4866}
4867
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004868component_test_aes_fewer_tables () {
4869 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004870 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004871 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004872
Gilles Peskine7c652162017-12-11 00:01:40 +01004873 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004874 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004875}
4876
4877component_test_aes_rom_tables () {
4878 msg "build: default config with AES_ROM_TABLES enabled"
4879 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004880 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004881
4882 msg "test: AES_ROM_TABLES"
4883 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004884}
4885
Gilles Peskine14c3c062018-01-29 21:25:12 +01004886component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004887 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4888 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4889 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004890 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004891
Gilles Peskine8f073122018-11-27 15:58:47 +01004892 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4893 make test
4894}
4895
Yanray Wang49cd4b52023-11-10 11:58:37 +08004896# helper for common_block_cipher_no_decrypt() which:
4897# - enable/disable the list of config options passed from -s/-u respectively.
4898# - build
4899# - test for tests_suite_xxx
4900# - selftest
4901#
4902# Usage: helper_block_cipher_no_decrypt_build_test
4903# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4904# Options: -s set_opts the list of config options to enable
4905# -u unset_opts the list of config options to disable
4906# -c cflags the list of options passed to CFLAGS
4907# -l ldflags the list of options passed to LDFLAGS
4908helper_block_cipher_no_decrypt_build_test () {
4909 while [ $# -gt 0 ]; do
4910 case "$1" in
4911 -s)
4912 shift; local set_opts="$1";;
4913 -u)
4914 shift; local unset_opts="$1";;
4915 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004916 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004917 -l)
4918 shift; local ldflags="$1";;
4919 esac
4920 shift
4921 done
4922 set_opts="${set_opts:-}"
4923 unset_opts="${unset_opts:-}"
4924 cflags="${cflags:-}"
4925 ldflags="${ldflags:-}"
4926
Yanray Wangb2d6e522023-11-13 16:57:47 +08004927 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4928 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004929
4930 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4931 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004932 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004933
4934 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4935 not grep mbedtls_aes_setkey_dec library/aes.o
4936 not grep mbedtls_aria_setkey_dec library/aria.o
4937 not grep mbedtls_camellia_setkey_dec library/camellia.o
4938 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4939 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004940 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4941 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004942
4943 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4944 make test
4945
4946 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4947 programs/test/selftest
4948}
4949
4950# This is a common configuration function used in:
4951# - component_test_block_cipher_no_decrypt_aesni_legacy()
4952# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4953# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4954# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4955# on x86.
4956common_block_cipher_no_decrypt () {
4957 # test AESNI intrinsics
4958 helper_block_cipher_no_decrypt_build_test \
4959 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004960 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004961
4962 # test AESNI assembly
4963 helper_block_cipher_no_decrypt_build_test \
4964 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004965 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004966
4967 # test AES C implementation
4968 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004969 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004970
4971 # test AESNI intrinsics for i386 target
4972 helper_block_cipher_no_decrypt_build_test \
4973 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004974 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004975 -l "-m32"
4976}
4977
Yanray Wang3ae11992023-11-13 17:32:09 +08004978# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4979# usage: 0: no PSA crypto configuration
4980# 1: use PSA crypto configuration
4981config_block_cipher_no_decrypt () {
4982 use_psa=$1
4983
Yanray Wang66111392023-10-31 18:54:54 +08004984 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004985 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4986 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004987 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004988 scripts/config.py unset MBEDTLS_NIST_KW_C
4989
Yanray Wang3ae11992023-11-13 17:32:09 +08004990 if [ "$use_psa" -eq 1 ]; then
4991 # Enable support for cryptographic mechanisms through the PSA API.
4992 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4993 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4994 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4995 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4996 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4997 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4998 fi
4999}
5000
5001component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005002 # This consistently causes an llvm crash on clang 3.8, so use gcc
5003 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005004 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005005 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005006}
5007
Yanray Wangf1496402023-11-01 18:55:13 +08005008component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005009 # This consistently causes an llvm crash on clang 3.8, so use gcc
5010 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005011 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005012 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005013}
5014
Yanray Wang66111392023-10-31 18:54:54 +08005015support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005016 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005017}
5018
Yanray Wang66111392023-10-31 18:54:54 +08005019component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005020 scripts/config.py baremetal
5021
5022 # armc[56] don't support SHA-512 intrinsics
5023 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5024
5025 # Stop armclang warning about feature detection for A64_CRYPTO.
5026 # With this enabled, the library does build correctly under armclang,
5027 # but in baremetal builds (as tested here), feature detection is
5028 # unavailable, and the user is notified via a #warning. So enabling
5029 # this feature would prevent us from building with -Werror on
5030 # armclang. Tracked in #7198.
5031 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5032 scripts/config.py set MBEDTLS_HAVE_ASM
5033
Yanray Wang3ae11992023-11-13 17:32:09 +08005034 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005035
5036 # test AESCE baremetal build
5037 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005038 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005039 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005040
Yanray Wangef1b04d2023-09-08 11:09:26 +08005041 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5042 not grep mbedtls_aes_setkey_dec library/aes.o
5043 not grep mbedtls_aria_setkey_dec library/aria.o
5044 not grep mbedtls_camellia_setkey_dec library/camellia.o
5045 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5046 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005047 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005048 not grep mbedtls_aesce_inverse_key library/aesce.o
5049 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005050}
5051
Gilles Peskine592f5912019-10-07 18:49:32 +02005052component_test_ctr_drbg_aes_256_sha_256 () {
5053 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5054 scripts/config.py full
5055 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5056 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005057 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005058 make
5059
5060 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5061 make test
5062}
5063
5064component_test_ctr_drbg_aes_128_sha_512 () {
5065 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005066 scripts/config.py full
5067 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5068 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005069 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005070 make
5071
5072 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5073 make test
5074}
5075
5076component_test_ctr_drbg_aes_128_sha_256 () {
5077 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005078 scripts/config.py full
5079 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5080 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5081 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005082 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005083 make
5084
5085 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5086 make test
5087}
5088
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005089component_test_se_default () {
5090 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005091 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005092 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005093
5094 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5095 make test
5096}
5097
Steven Cooremand57203d2020-07-16 20:28:59 +02005098component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005099 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005100 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005101 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005102 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5103 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005104 loc_cflags="${loc_cflags} -I../tests/include -O2"
5105
Gilles Peskine21570cf2023-12-22 11:49:50 +01005106 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005107
Gilles Peskine1997f302023-07-26 18:45:20 +02005108 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005109 make test
5110}
5111
Gilles Peskine8f073122018-11-27 15:58:47 +01005112component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005113 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005114 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005115 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005116 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005117}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005118
Gilles Peskinecf740502019-07-03 20:43:05 +02005119component_test_cmake_shared () {
5120 msg "build/test: cmake shared" # ~ 2min
5121 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5122 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005123 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005124 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005125 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005126}
5127
Gilles Peskineec10bf12019-09-20 19:56:06 +02005128test_build_opt () {
5129 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005130 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005131 for opt in "$@"; do
5132 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005133 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005134 # We're confident enough in compilers to not run _all_ the tests,
5135 # but at least run the unit tests. In particular, runs with
5136 # optimizations use inline assembly whereas runs with -O0
5137 # skip inline assembly.
5138 make test # ~30s
5139 make clean
5140 done
5141}
5142
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005143# For FreeBSD we invoke the function by name so this condition is added
5144# to disable the existing test_clang_opt function for linux.
5145if [[ $(uname) != "Linux" ]]; then
5146 component_test_clang_opt () {
5147 scripts/config.py full
5148 test_build_opt 'full config' clang -O0 -Os -O2
5149 }
5150fi
5151
5152component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005153 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005154 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005155}
5156support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005157 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005158}
5159
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005160component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005161 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005162 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005163}
5164support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005165 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005166}
5167
5168component_test_gcc_latest_opt () {
5169 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005170 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005171}
5172support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005173 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005174}
5175
5176component_test_gcc_earliest_opt () {
5177 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005178 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005179}
5180support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005181 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005182}
5183
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005184component_build_mbedtls_config_file () {
5185 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005186 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005187 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005188 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005189 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005190 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5191 make clean
5192
5193 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5194 # In the user config, disable one feature (for simplicity, pick a feature
5195 # that nothing else depends on).
5196 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005197 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005198 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5199
5200 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005201}
5202
Gilles Peskine7d904e72022-04-07 21:59:14 +02005203component_build_psa_config_file () {
5204 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5205 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5206 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5207 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5208 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005209 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005210 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5211 make clean
5212
5213 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005214 # In the user config, disable one feature and its dependencies, which will
5215 # reflect on the mbedtls configuration so we can query it with
5216 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005217 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005218 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005219 scripts/config.py unset MBEDTLS_CMAC_C
5220 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5221 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5222
5223 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005224}
5225
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005226component_build_psa_alt_headers () {
5227 msg "build: make with PSA alt headers" # ~20s
5228
5229 # Generate alternative versions of the substitutable headers with the
5230 # same content except different include guards.
5231 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5232
5233 # Build the library and some programs.
5234 # Don't build the fuzzers to avoid having to go through hoops to set
5235 # a correct include path for programs/fuzz/Makefile.
5236 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
5237 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\"'"
5238
5239 # Check that we're getting the alternative include guards and not the
5240 # original include guards.
5241 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5242 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5243 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5244 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5245}
5246
Dave Rodgman852de3c2023-12-14 14:46:45 +00005247component_test_m32_no_asm () {
5248 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005249 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005250 #
5251 # Note that we require gcc, because clang Asan builds fail to link for
5252 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005253 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005254 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005255 scripts/config.py unset MBEDTLS_HAVE_ASM
5256 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005257 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005258 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005259
Dave Rodgman852de3c2023-12-14 14:46:45 +00005260 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005261 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005262}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005263support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005264 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005265 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005266 *) false;;
5267 esac
5268}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005269
Gilles Peskineff0aee02021-10-05 09:36:03 +02005270component_test_m32_o2 () {
5271 # Build with optimization, to use the i386 specific inline assembly
5272 # and go faster for tests.
5273 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005274 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005275 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005276 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005277
Gilles Peskineff0aee02021-10-05 09:36:03 +02005278 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005279 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005280
Gilles Peskineff0aee02021-10-05 09:36:03 +02005281 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005282 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005283}
Gilles Peskinecf522222021-10-07 19:25:29 +02005284support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005285 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005286}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005287
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005288component_test_m32_everest () {
5289 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005290 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005291 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005292 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005293
5294 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5295 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005296
5297 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005298 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005299
5300 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5301 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005302 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005303}
5304support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005305 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005306}
5307
Gilles Peskine8f073122018-11-27 15:58:47 +01005308component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005309 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005310 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005311 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005312
5313 msg "test: 64-bit ILP32, make, gcc"
5314 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005315}
Gilles Peskine878cf602019-01-06 20:50:38 +00005316support_test_mx32 () {
5317 case $(uname -m) in
5318 amd64|x86_64) true;;
5319 *) false;;
5320 esac
5321}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005322
Peter Kolbus60c6da22018-12-27 06:59:04 -06005323component_test_min_mpi_window_size () {
5324 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005325 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005326 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005327 make
5328
5329 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5330 make test
5331}
5332
Gilles Peskine8f073122018-11-27 15:58:47 +01005333component_test_have_int32 () {
5334 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005335 scripts/config.py unset MBEDTLS_HAVE_ASM
5336 scripts/config.py unset MBEDTLS_AESNI_C
5337 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005338 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005339 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005340
Gilles Peskine8f073122018-11-27 15:58:47 +01005341 msg "test: gcc, force 32-bit bignum limbs"
5342 make test
5343}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005344
Gilles Peskine8f073122018-11-27 15:58:47 +01005345component_test_have_int64 () {
5346 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005347 scripts/config.py unset MBEDTLS_HAVE_ASM
5348 scripts/config.py unset MBEDTLS_AESNI_C
5349 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005350 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005351 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005352
Gilles Peskine8f073122018-11-27 15:58:47 +01005353 msg "test: gcc, force 64-bit bignum limbs"
5354 make test
5355}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005356
Gabor Mezeie256cc12023-07-26 17:28:48 +02005357component_test_have_int32_cmake_new_bignum () {
5358 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5359 scripts/config.py unset MBEDTLS_HAVE_ASM
5360 scripts/config.py unset MBEDTLS_AESNI_C
5361 scripts/config.py unset MBEDTLS_PADLOCK_C
5362 scripts/config.py unset MBEDTLS_AESCE_C
5363 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005364 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005365 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005366
5367 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5368 make test
5369}
5370
Gilles Peskine8f073122018-11-27 15:58:47 +01005371component_test_no_udbl_division () {
5372 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005373 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005374 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005375 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005376
Gilles Peskine8f073122018-11-27 15:58:47 +01005377 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5378 make test
5379}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005380
Gilles Peskine8f073122018-11-27 15:58:47 +01005381component_test_no_64bit_multiplication () {
5382 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005383 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005384 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005385 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005386
Gilles Peskine8f073122018-11-27 15:58:47 +01005387 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5388 make test
5389}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005390
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005391component_test_no_strings () {
5392 msg "build: no strings" # ~10s
5393 scripts/config.py full
5394 # Disable options that activate a large amount of string constants.
5395 scripts/config.py unset MBEDTLS_DEBUG_C
5396 scripts/config.py unset MBEDTLS_ERROR_C
5397 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5398 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005399 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005400
5401 msg "test: no strings" # ~ 10s
5402 make test
5403}
5404
Hanno Beckerc5722d12020-10-09 11:10:42 +01005405component_test_no_x509_info () {
5406 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5407 scripts/config.pl full
5408 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5409 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005410 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005411
5412 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5413 make test
5414
5415 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005416 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005417}
5418
Gilles Peskine8f073122018-11-27 15:58:47 +01005419component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005420 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005421 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005422 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 +02005423
Gilles Peskinee36fe812021-09-01 20:00:33 +02005424 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005425 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005426}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005427
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005428component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005429 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005430 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005431 # Build for a target platform that's close to what Debian uses
5432 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005433 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005434 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005435 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005436 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'
5437
Gilles Peskinee36fe812021-09-01 20:00:33 +02005438 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005439 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005440}
5441support_build_arm_linux_gnueabi_gcc_arm5vte () {
5442 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5443}
5444
5445component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005446 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005447 scripts/config.py baremetal
5448 # This is an imperfect substitute for
5449 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005450 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005451 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 +02005452
Gilles Peskinee36fe812021-09-01 20:00:33 +02005453 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005454 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005455}
5456
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005457component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005458 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5459 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005460 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 +02005461
Gilles Peskinee36fe812021-09-01 20:00:33 +02005462 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005463 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005464 for lib in library/*.a; do
5465 echo "$lib:"
5466 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5467 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005468}
5469
Gilles Peskine8f073122018-11-27 15:58:47 +01005470component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005471 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005472 scripts/config.py baremetal
5473 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005474 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 +01005475 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005476 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005477}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005478
Gilles Peskine8f073122018-11-27 15:58:47 +01005479component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005480 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005481 scripts/config.py baremetal
5482 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005483 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 +01005484 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005485 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005486}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005487
Dave Rodgman8c315f22023-06-02 10:26:24 -04005488component_build_arm_clang_thumb () {
5489 # ~ 30s
5490
5491 scripts/config.py baremetal
5492
5493 msg "build: clang thumb 2, make"
5494 make clean
5495 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5496
5497 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5498 msg "build: clang thumb 1 -O0, make"
5499 make clean
5500 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5501
5502 msg "build: clang thumb 1 -Os, make"
5503 make clean
5504 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5505}
5506
Gilles Peskine8f073122018-11-27 15:58:47 +01005507component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005508 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005509 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005510 # armc[56] don't support SHA-512 intrinsics
5511 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005512
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005513 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5514 scripts/config.py unset MBEDTLS_AESCE_C
5515
Dave Rodgman0fddf822023-03-02 15:32:12 +00005516 # Stop armclang warning about feature detection for A64_CRYPTO.
5517 # With this enabled, the library does build correctly under armclang,
5518 # but in baremetal builds (as tested here), feature detection is
5519 # unavailable, and the user is notified via a #warning. So enabling
5520 # this feature would prevent us from building with -Werror on
5521 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005522 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005523
Hanno Beckerf0762e92022-07-15 12:08:19 +01005524 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005525
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005526 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005527
5528 msg "size: ARM Compiler 5"
5529 "$ARMC5_FROMELF" -z library/*.o
5530
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005531 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005532
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005533 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005534 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005535
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005536 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005537 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5538
5539 # ARM Compiler 6 - Target ARMv7-M+DSP
5540 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005541
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005542 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005543 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005544
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005545 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005546 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005547
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005548 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5549 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5550
Dave Rodgman99318e62023-05-24 12:27:42 +01005551 # ARM Compiler 6 - Target Cortex-M0
5552 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005553
5554 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5555 #
5556 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5557 # that we have in our CI
5558 scripts/config.py set MBEDTLS_AESCE_C
5559 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005560}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005561
Pengyu Lvdf070032023-02-24 16:03:31 +08005562support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005563 armc5_cc="$ARMC5_BIN_DIR/armcc"
5564 armc6_cc="$ARMC6_BIN_DIR/armclang"
5565 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005566}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005567
Ronald Crond2cb7f42024-03-18 12:49:18 +01005568component_test_tls12_only () {
5569 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5570 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5571 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5572 make
5573
5574 msg "test: main suites (inc. selftests) (ASan build)"
5575 make test
5576
5577 msg "test: ssl-opt.sh (ASan build)"
5578 tests/ssl-opt.sh
5579
5580 msg "test: compat.sh (ASan build)"
5581 tests/compat.sh
5582}
5583
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005584component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005585 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005586 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005587 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005588 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5589
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005590 msg "test: TLS 1.3 only, all key exchange modes enabled"
5591 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005592
Ronald Cronc3f43b62022-10-17 17:35:32 +02005593 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5594 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005595}
5596
Ronald Cronc3f43b62022-10-17 17:35:32 +02005597component_test_tls13_only_psk () {
5598 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5599 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5600 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5601 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005602 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005603 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5604 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5605 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5606 scripts/config.py unset MBEDTLS_ECDSA_C
5607 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005608 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005609 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005610 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5611
Ronald Cronc3f43b62022-10-17 17:35:32 +02005612 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5613 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005614
Ronald Cronc3f43b62022-10-17 17:35:32 +02005615 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5616 tests/ssl-opt.sh
5617}
5618
5619component_test_tls13_only_ephemeral () {
5620 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5621 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5622 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005623 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005624 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5625
5626 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5627 cd tests; ./test_suite_ssl; cd ..
5628
5629 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5630 tests/ssl-opt.sh
5631}
5632
Przemek Stekiela01c2422023-06-13 10:46:48 +02005633component_test_tls13_only_ephemeral_ffdh () {
5634 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5635 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5636 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5637 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005638 scripts/config.py unset MBEDTLS_ECDH_C
5639
Przemek Stekiela01c2422023-06-13 10:46:48 +02005640 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5641
5642 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5643 cd tests; ./test_suite_ssl; cd ..
5644
5645 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5646 tests/ssl-opt.sh
5647}
5648
Ronald Cronc3f43b62022-10-17 17:35:32 +02005649component_test_tls13_only_psk_ephemeral () {
5650 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5651 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5652 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5653 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5654 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5655 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5656 scripts/config.py unset MBEDTLS_ECDSA_C
5657 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005658 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005659 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005660 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5661
5662 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5663 cd tests; ./test_suite_ssl; cd ..
5664
5665 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5666 tests/ssl-opt.sh
5667}
5668
Przemek Stekiela01c2422023-06-13 10:46:48 +02005669component_test_tls13_only_psk_ephemeral_ffdh () {
5670 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5671 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5672 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5673 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5674 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5675 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5676 scripts/config.py unset MBEDTLS_ECDSA_C
5677 scripts/config.py unset MBEDTLS_PKCS1_V21
5678 scripts/config.py unset MBEDTLS_PKCS7_C
5679 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005680 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005681 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5682
5683 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5684 cd tests; ./test_suite_ssl; cd ..
5685
5686 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5687 tests/ssl-opt.sh
5688}
5689
Ronald Cronc3f43b62022-10-17 17:35:32 +02005690component_test_tls13_only_psk_all () {
5691 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5692 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5693 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5694 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5695 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5696 scripts/config.py unset MBEDTLS_ECDSA_C
5697 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005698 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005699 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005700 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5701
5702 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5703 cd tests; ./test_suite_ssl; cd ..
5704
5705 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5706 tests/ssl-opt.sh
5707}
5708
5709component_test_tls13_only_ephemeral_all () {
5710 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5711 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005712 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005713 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5714
5715 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5716 cd tests; ./test_suite_ssl; cd ..
5717
5718 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5719 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005720}
5721
Ronald Cron46ac0652024-03-18 12:39:04 +01005722component_test_tls13_no_padding () {
5723 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005724 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005725 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005726 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005727 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005728 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005729 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005730 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005731 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005732}
5733
Ronald Cron6f135e12021-12-08 16:57:54 +01005734component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005735 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005736 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005737 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005738 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005739 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005740 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005741 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005742 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005743 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005744}
5745
Ronald Crondd96c0a2024-04-02 12:34:24 +02005746component_test_full_minus_session_tickets() {
5747 msg "build: full config without session tickets"
5748 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005749 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005750 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005751 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5752 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005753 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005754 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005755 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005756 tests/ssl-opt.sh
5757}
5758
Gilles Peskine8f073122018-11-27 15:58:47 +01005759component_build_mingw () {
5760 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005761 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 +00005762
Gilles Peskine8f073122018-11-27 15:58:47 +01005763 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005764 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 +01005765 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005766
Gilles Peskine8f073122018-11-27 15:58:47 +01005767 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005768 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
5769 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 +01005770 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005771
Pengyu Lv158eead2023-10-19 11:27:05 +08005772 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005773 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005774 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 +01005775 make WINDOWS_BUILD=1 clean
5776}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005777support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005778 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5779 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005780 *) true;;
5781 esac
5782}
Simon Butcher91aef332016-11-17 09:20:50 +00005783
Gilles Peskine8f073122018-11-27 15:58:47 +01005784component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005785 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005786 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005787 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5788 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005789
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005790 msg "test: main suites (MSan)" # ~ 10s
5791 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005792
Gilles Peskine6848d172023-11-02 19:58:03 +01005793 msg "test: metatests (MSan)"
5794 tests/scripts/run-metatests.sh any msan
5795
Gilles Peskine82b27272019-06-14 18:27:03 +02005796 msg "program demos (MSan)" # ~20s
5797 tests/scripts/run_demos.py
5798
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005799 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005800 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005801
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005802 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005803
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005804 if [ "$MEMORY" -gt 0 ]; then
5805 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005806 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005807 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005808}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005809
Bence Szépkúti0354d042023-12-06 16:14:37 +01005810component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005811 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005812 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005813 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5814 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005815
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005816 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005817 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005818
Gilles Peskine636c26a2020-03-04 20:46:15 +01005819 # Optional parts (slow; currently broken on OS X because programs don't
5820 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005821 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005822 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005823 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005824 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005825 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005826
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005827 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005828 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005829 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005830 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005831
5832 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005833 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005834 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005835 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005836}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005837
Bence Szépkúti0354d042023-12-06 16:14:37 +01005838component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005839 msg "build: Release, full (clang)"
5840 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5841 scripts/config.py full
5842 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5843 make
5844
5845 msg "test: main suites, Valgrind (full config)"
5846 make memcheck
5847}
5848
Paul Elliott62dc3922021-11-25 17:29:40 +00005849support_test_cmake_out_of_source () {
5850 distrib_id=""
5851 distrib_ver=""
5852 distrib_ver_minor=""
5853 distrib_ver_major=""
5854
5855 # Attempt to parse lsb-release to find out distribution and version. If not
5856 # found this should fail safe (test is supported).
5857 if [[ -f /etc/lsb-release ]]; then
5858
5859 while read -r lsb_line; do
5860 case "$lsb_line" in
5861 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5862 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5863 esac
5864 done < /etc/lsb-release
5865
5866 distrib_ver_major="${distrib_ver%%.*}"
5867 distrib_ver="${distrib_ver#*.}"
5868 distrib_ver_minor="${distrib_ver%%.*}"
5869 fi
5870
5871 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5872 # processor (as the CI does) can create a race condition whereby the build
5873 # fails to see a generated file, despite that file actually having been
5874 # generated. This problem appears to go away with 18.04 or newer, so make
5875 # the out of source tests unsupported on Ubuntu 16.04.
5876 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5877}
5878
Gilles Peskine8f073122018-11-27 15:58:47 +01005879component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005880 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005881 # generates
5882 make neat
5883
Gilles Peskine8f073122018-11-27 15:58:47 +01005884 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005885 MBEDTLS_ROOT_DIR="$PWD"
5886 mkdir "$OUT_OF_SOURCE_DIR"
5887 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005888 # Note: Explicitly generate files as these are turned off in releases
5889 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005890 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005891
Gilles Peskine8f073122018-11-27 15:58:47 +01005892 msg "test: cmake 'out-of-source' build"
5893 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005894 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005895 # Also ensure that there are no error messages such as
5896 # "No such file or directory", which would indicate that some required
5897 # file is missing (ssl-opt.sh tolerates the absence of some files so
5898 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005899 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005900 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005901 cat ssl-opt.err >&2
5902 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005903 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005904 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005905 cd "$MBEDTLS_ROOT_DIR"
5906 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005907}
Andres AGdc192212016-08-31 17:33:13 +01005908
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005909component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005910 # Remove existing generated files so that we use the ones CMake
5911 # generates
5912 make neat
5913
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005914 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005915 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005916 # Note: Explicitly generate files as these are turned off in releases
5917 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005918 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005919 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005920}
Gilles Peskinea3000992022-02-04 00:21:12 +01005921support_test_cmake_as_subdirectory () {
5922 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005923}
5924
Chris Kayd259e342021-03-25 16:03:25 +00005925component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005926 # Remove existing generated files so that we use the ones CMake
5927 # generates
5928 make neat
5929
Chris Kayd259e342021-03-25 16:03:25 +00005930 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005931 cd programs/test/cmake_package
5932 cmake .
5933 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005934 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005935}
Gilles Peskinea3000992022-02-04 00:21:12 +01005936support_test_cmake_as_package () {
5937 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005938}
5939
5940component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005941 # Remove existing generated files so that we use the ones CMake
5942 # generates
5943 make neat
5944
Chris Kayd259e342021-03-25 16:03:25 +00005945 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005946 cd programs/test/cmake_package_install
5947 cmake .
5948 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005949 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005950}
Gilles Peskinea3000992022-02-04 00:21:12 +01005951support_test_cmake_as_package_install () {
5952 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005953}
5954
David Horstmann20550e32023-01-12 14:17:01 +00005955component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005956 # Make a copy of config file to use for the in-tree test
5957 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005958
5959 MBEDTLS_ROOT_DIR="$PWD"
5960 mkdir "$OUT_OF_SOURCE_DIR"
5961 cd "$OUT_OF_SOURCE_DIR"
5962
David Horstmann969c1452023-01-31 10:34:44 +00005963 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005964 cmake "$MBEDTLS_ROOT_DIR"
5965 make
5966
5967 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5968 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005969 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005970 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5971 make
5972
5973 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5974 # In the user config, disable one feature (for simplicity, pick a feature
5975 # that nothing else depends on).
5976 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5977
5978 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5979 make
5980 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5981
5982 rm -f user_config.h full_config.h
5983
5984 cd "$MBEDTLS_ROOT_DIR"
5985 rm -rf "$OUT_OF_SOURCE_DIR"
5986
5987 # Now repeat the test for an in-tree build:
5988
David Horstmann969c1452023-01-31 10:34:44 +00005989 # Restore config for the in-tree test
5990 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005991
David Horstmann969c1452023-01-31 10:34:44 +00005992 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005993 cmake .
5994 make
5995
5996 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5997 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005998 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005999 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6000 make
6001
6002 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6003 # In the user config, disable one feature (for simplicity, pick a feature
6004 # that nothing else depends on).
6005 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6006
6007 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6008 make
6009 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6010
6011 rm -f user_config.h full_config.h
6012}
6013support_build_cmake_custom_config_file () {
6014 support_test_cmake_out_of_source
6015}
6016
David Horstmann041ed422024-05-10 14:37:48 +01006017component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006018 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006019 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6020 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6021 make
6022}
6023support_build_cmake_programs_no_testing () {
6024 support_test_cmake_out_of_source
6025}
David Horstmann20550e32023-01-12 14:17:01 +00006026
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006027component_build_zeroize_checks () {
6028 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6029
6030 scripts/config.py full
6031
6032 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006033 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 +01006034}
6035
6036
Gilles Peskine8f073122018-11-27 15:58:47 +01006037component_test_zeroize () {
6038 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6039 # different combinations of compilers and optimization flags by using an
6040 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6041 # system in all cases that the script fails, so we must manually search the
6042 # output to check whether the pass string is present and no failure strings
6043 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006044
Gilles Peskine4976e822019-01-06 19:52:22 +00006045 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6046 # about a spurious message if Gdb tries and fails, so suppress that.
6047 gdb_disable_aslr=
6048 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6049 gdb_disable_aslr='set disable-randomization off'
6050 fi
6051
Gilles Peskine8f073122018-11-27 15:58:47 +01006052 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006053 for compiler in clang gcc; do
6054 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6055 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006056 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6057 grep "The buffer was correctly zeroized" test_zeroize.log
6058 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006059 rm -f test_zeroize.log
6060 make clean
6061 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006062 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006063}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006064
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006065component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006066 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006067 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006068 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006069
6070 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006071 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006072}
6073
6074support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006075 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006076 ver="$(cmake --version)"
6077 ver="${ver#cmake version }"
6078 ver_major="${ver%%.*}"
6079
6080 ver="${ver#*.}"
6081 ver_minor="${ver%%.*}"
6082
6083 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006084}
6085
Gilles Peskinec848d222022-12-09 12:23:35 +01006086component_check_code_style () {
6087 msg "Check C code style"
6088 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006089}
6090
Gilles Peskinec848d222022-12-09 12:23:35 +01006091support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006092 case $(uncrustify --version) in
6093 *0.75.1*) true;;
6094 *) false;;
6095 esac
6096}
6097
Gilles Peskine8f073122018-11-27 15:58:47 +01006098component_check_python_files () {
6099 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006100 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006101}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006102
Joe Subbianid614c0b2021-07-29 11:18:29 +01006103component_check_test_helpers () {
6104 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006105 # unittest writes out mundane stuff like number or tests run on stderr.
6106 # Our convention is to reserve stderr for actual errors, and write
6107 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006108 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006109
Joe Subbiania25ffab2021-08-06 09:41:27 +01006110 msg "unit test: translate_ciphers.py"
6111 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006112}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006113
Valerio Settid9e42512024-05-06 15:59:51 +02006114component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006115 msg "build library for server"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006116 scripts/config.py crypto
Valerio Settid1b6ef12024-05-07 16:00:21 +02006117 helper_crypto_client_build server
6118
Valerio Settif98635c2024-06-10 20:13:13 +02006119 msg "build server"
6120 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_partition
6121
6122 # cleanup() will restore some backed-up files which include $CONFIG_H and
6123 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
6124 # point.
6125 cleanup
6126
6127 msg "build library for client"
6128 helper_crypto_client_build client
6129
6130 msg "build psasim to test psa_client"
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01006131 rm -f tests/psa-client-server/psasim/test/psa_client # In case left behind
Valerio Settif98635c2024-06-10 20:13:13 +02006132 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client
Valerio Settid9e42512024-05-06 15:59:51 +02006133
6134 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006135 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006136
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006137
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006138 msg "build psasim to test psa_hash_compute"
6139 # Delete the executable to ensure we build using the right MAIN
6140 rm tests/psa-client-server/psasim/test/psa_client
6141 # API under test: psa_hash_compute()
Valerio Settif98635c2024-06-10 20:13:13 +02006142 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash_compute.c" test/psa_client
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006143
6144 msg "test psasim running psa_hash_compute"
6145 tests/psa-client-server/psasim/test/run_test.sh
6146
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006147
Valerio Settif98635c2024-06-10 20:13:13 +02006148 # Next APIs under test: psa_hash_*(). Use our copy of the PSA hash example.
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006149 msg "build psasim to test all psa_hash_* APIs"
6150 # Delete the executable to ensure we build using the right MAIN
6151 rm tests/psa-client-server/psasim/test/psa_client
Valerio Settif98635c2024-06-10 20:13:13 +02006152 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash.c" test/psa_client
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006153
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006154 msg "test psasim running psa_hash sample"
6155 tests/psa-client-server/psasim/test/run_test.sh
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006156
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006157
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01006158 # Next APIs under test: psa_aead_*(). Use our copy of the PSA aead example.
6159 msg "build psasim to test all psa_aead_* APIs"
6160 # Delete the executable to ensure we build using the right MAIN
6161 rm tests/psa-client-server/psasim/test/psa_client
6162 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_aead_demo.c" test/psa_client
6163
6164 msg "test psasim running psa_aead_demo sample"
6165 tests/psa-client-server/psasim/test/run_test.sh aes128-gcm
6166 tests/psa-client-server/psasim/test/run_test.sh aes256-gcm
6167 tests/psa-client-server/psasim/test/run_test.sh aes128-gcm_8
6168 tests/psa-client-server/psasim/test/run_test.sh chachapoly
Gilles Peskine8f073122018-11-27 15:58:47 +01006169
6170 msg "clean psasim"
6171 make -C tests/psa-client-server/psasim clean
6172}
6173
6174################################################################
6175#### Termination
Gilles Peskine5d996822020-03-28 21:09:21 +01006176################################################################
6177
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006178post_report () {
Gilles Peskine5d996822020-03-28 21:09:21 +01006179 msg "Done, cleaning up"
6180 final_cleanup
6181
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006182 final_report
6183}
6184
Gilles Peskineec135542021-08-02 23:14:03 +02006185
Gilles Peskine5d996822020-03-28 21:09:21 +01006186
Gilles Peskineec135542021-08-02 23:14:03 +02006187################################################################
Gilles Peskine5d996822020-03-28 21:09:21 +01006188#### Run all the things
Gilles Peskineec135542021-08-02 23:14:03 +02006189################################################################
Gilles Peskine5d996822020-03-28 21:09:21 +01006190
6191# Function invoked by --error-test to test error reporting.
6192pseudo_component_error_test () {
6193 msg "Testing error reporting $error_test_i"
Gilles Peskinee48351a2018-11-27 16:06:30 +01006194 if [ $KEEP_GOING -ne 0 ]; then
Gilles Peskine8f073122018-11-27 15:58:47 +01006195 echo "Expect three failing commands."
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006196 fi
Gilles Peskine9004a172019-09-16 15:20:36 +02006197 # If the component doesn't run in a subshell, changing error_test_i to an
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006198 # invalid integer will cause an error in the loop that runs this function.
6199 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
6200 # Expected error: 'grep non_existent /dev/null -> 1'
6201 grep non_existent /dev/null
Gilles Peskine88a07452021-07-08 19:03:50 +02006202 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
6203 not grep -q . "$0"
6204 # Expected error: 'make unknown_target -> 2'
Tom Cosgrove226aca12022-03-16 14:11:07 +00006205 make unknown_target
Gilles Peskine88a07452021-07-08 19:03:50 +02006206 false "this should not be executed"
6207}
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006208
Gilles Peskineec135542021-08-02 23:14:03 +02006209# Run one component and clean up afterwards.
6210run_component () {
Gilles Peskinece266c42020-03-28 18:50:43 +01006211 current_component="$1"
Gilles Peskineec135542021-08-02 23:14:03 +02006212 export MBEDTLS_TEST_CONFIGURATION="$current_component"
6213
Gilles Peskinece266c42020-03-28 18:50:43 +01006214 # Unconditionally create a seedfile that's sufficiently long.
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006215 # Do this before each component, because a previous component may
Gilles Peskinece266c42020-03-28 18:50:43 +01006216 # have messed it up or shortened it.
6217 local dd_cmd
6218 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6219 case $OSTYPE in
6220 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
6221 esac
6222 "${dd_cmd[@]}"
6223
6224 # Run the component in a subshell, with error trapping and output
6225 # redirection set up based on the relevant options.
6226 if [ $KEEP_GOING -eq 1 ]; then
6227 # We want to keep running if the subshell fails, so 'set -e' must
6228 # be off when the subshell runs.
6229 set +e
6230 fi
6231 (
6232 if [ $QUIET -eq 1 ]; then
6233 # msg() will be silenced, so just print the component name here.
6234 echo "${current_component#component_}"
6235 exec >/dev/null
6236 fi
6237 if [ $KEEP_GOING -eq 1 ]; then
6238 # Keep "set -e" off, and run an ERR trap instead to record failures.
6239 set -E
6240 trap err_trap ERR
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006241 fi
6242 # The next line is what runs the component
Gilles Peskinee48351a2018-11-27 16:06:30 +01006243 "$@"
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006244 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskine8f073122018-11-27 15:58:47 +01006245 trap - ERR
6246 exit $last_failure_status
6247 fi
6248 )
6249 component_status=$?
6250 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006251 set -e
Dave Rodgman21900632024-02-26 11:41:19 +00006252 if [ $component_status -ne 0 ]; then
Gilles Peskine878cf602019-01-06 20:50:38 +00006253 failure_count=$((failure_count + 1))
Gilles Peskine568f53a2021-07-12 18:16:01 +02006254 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +02006255 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -05006256
Gilles Peskine878cf602019-01-06 20:50:38 +00006257 # Restore the build tree to a clean state.
6258 cleanup
6259 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006260}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006261
Gilles Peskine878cf602019-01-06 20:50:38 +00006262# Preliminary setup
6263pre_check_environment
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006264pre_initialize_variables
David Horstmann76a77382023-08-17 17:32:26 +01006265pre_parse_command_line "$@"
David Horstmann9a6c45b2023-07-14 12:30:00 +01006266
6267setup_quiet_wrappers
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006268pre_check_git
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006269pre_restore_files
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006270pre_back_up
Gilles Peskine5d996822020-03-28 21:09:21 +01006271
Gilles Peskine5d996822020-03-28 21:09:21 +01006272build_status=0
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006273if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006274 pre_setup_keep_going
6275fi
6276pre_prepare_outcome_file
Gilles Peskine8f073122018-11-27 15:58:47 +01006277pre_print_configuration
6278pre_check_tools
Gilles Peskine878cf602019-01-06 20:50:38 +00006279cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006280if in_mbedtls_repo; then
6281 pre_generate_files
6282fi
6283
6284# Run the requested tests.
6285for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
6286 run_component pseudo_component_error_test
6287done
6288unset error_test_i
6289for component in $RUN_COMPONENTS; do
6290 run_component "component_$component"
6291done
6292
6293# We're done.
6294post_report