blob: a1203f77268bdd200144c4e178ecdc16a8283a24 [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)
47# * OPENSSL_NEXT = 1.1.1a
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'
David Horstmann76a77382023-08-17 17:32:26 +0100136 else
137 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100138 fi
John Durkopbd069d32020-10-31 22:14:03 -0700139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100140 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200141
142 # Files that are clobbered by some jobs will be backed up. Use a different
143 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
144 # independently decide when to remove the backup file.
145 backup_suffix='.all.bak'
146 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100147 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100148 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 # Files clobbered by in-tree cmake
150 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
151 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200152
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200153 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100154 MEMORY=0
155 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200156 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100158
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200159 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200160 #
161 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
162 # both values are kept in sync. If you change the value here because it
163 # breaks some tests, you'll definitely want to change it in
164 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200165 RELEASE_SEED=1
166
Yanray Wang18040ed2023-11-23 21:29:56 +0800167 # Specify character collation for regular expressions and sorting with C locale
168 export LC_COLLATE=C
169
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200170 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200171 : ${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 +0200172 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200173 export MBEDTLS_TEST_PLATFORM
174
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000175 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL_NEXT:="$OPENSSL"}
178 : ${GNUTLS_CLI:="gnutls-cli"}
179 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100180 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
181 : ${ARMC5_BIN_DIR:=/usr/bin}
182 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200183 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200184 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100185 : ${CLANG_LATEST:="clang-latest"}
186 : ${CLANG_EARLIEST:="clang-earliest"}
187 : ${GCC_LATEST:="gcc-latest"}
188 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000190 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200191 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100192 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000193 # if CC is not set, use clang by default (if present) to improve build times
194 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000195 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000196 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000197
Gilles Peskine396853a2021-09-20 18:57:55 +0200198 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000199 export CTEST_OUTPUT_ON_FAILURE=1
200
Gilles Peskine8fd59422019-10-21 17:11:33 +0200201 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100202 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200203 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000204 # Normally, tests should use this compiler for ASAN testing
205 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200206
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400207 # Platform tests have an allocation that returns null
208 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400209 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400210
Gilles Peskine878cf602019-01-06 20:50:38 +0000211 # Gather the list of available components. These are the functions
212 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100213 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000214
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000215 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100216 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100217}
Andres AG38495a32016-07-12 16:54:33 +0100218
Dave Rodgman21900632024-02-26 11:41:19 +0000219setup_quiet_wrappers()
220{
221 # Pick up "quiet" wrappers for make and cmake, which don't output very much
222 # unless there is an error. This reduces logging overhead in the CI.
223 #
224 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000225 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
226 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000227 fi
228}
229
Gilles Peskinea28db922019-01-10 00:05:18 +0100230# Test whether the component $1 is included in the command line patterns.
231is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100232{
Gilles Peskine03af6782021-08-06 11:35:17 +0200233 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
234 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100235 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000236 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100237 set +f
238 case ${1#component_} in $pattern) return 0;; esac
239 done
240 set +f
241 return 1
242}
Andres AG7770ea82016-10-10 15:46:20 +0100243
Simon Butcher41eeccf2016-09-07 00:07:09 +0100244usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100245{
Gilles Peskine709346a2017-12-10 23:43:39 +0100246 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100247Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100248Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100249By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100250COMPONENT can be the name of a component or a shell wildcard pattern.
251
252Examples:
253 $0 "check_*"
254 Run all sanity checks.
255 $0 --no-armcc --except test_memsan
256 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100257
258Special options:
259 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000260 --list-all-components List all available test components and exit.
261 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100262
263General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200264 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100265 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100266 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100267 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200268 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200269 --arm-none-eabi-gcc-prefix=<string>
270 Prefix for a cross-compiler for arm-none-eabi
271 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200272 --arm-linux-gnueabi-gcc-prefix=<string>
273 Prefix for a cross-compiler for arm-linux-gnueabi
274 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100275 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200276 --restore First clean up the build tree, restoring backed up
277 files. Do not run any components unless they are
278 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100279 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200280 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100281 --except Exclude the COMPONENTs listed on the command line,
282 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200283 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100284 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100285 --no-force Refuse to overwrite modified files (default).
286 --no-keep-going Stop at the first error (default).
287 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800288 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100289 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200290 --outcome-file=<path> File where test outcomes are written (not done if
291 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100292 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200293 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100294 -s|--seed Integer seed value to use for this test run.
295
296Tool path options:
297 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
298 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100299 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
300 --clang-latest=<Clang_latest_path> Latest version of clang available
301 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
302 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100303 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
304 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100305 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100306 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100307EOF
SimonB2e23c822016-04-16 21:54:39 +0100308}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100309
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200310# Cleanup before/after running a component.
311# Remove built files as well as the cmake cache/config.
312# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313cleanup()
314{
David Horstmann76a77382023-08-17 17:32:26 +0100315 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100316 command make clean
317 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200318
Gilles Peskine31b07e22018-03-21 12:15:06 +0100319 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000320 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100321 -iname CMakeFiles -exec rm -rf {} \+ -o \
322 \( -iname cmake_install.cmake -o \
323 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200324 -iname CMakeCache.txt -o \
325 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100326 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200327 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200328
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100329 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
330 rm -rf programs/test/cmake_subproject/build
331 rm -f programs/test/cmake_subproject/Makefile
332 rm -f programs/test/cmake_subproject/cmake_subproject
333
Chris Kayd259e342021-03-25 16:03:25 +0000334 # Remove any artifacts from the component_test_cmake_as_package test.
335 rm -rf programs/test/cmake_package/build
336 rm -f programs/test/cmake_package/Makefile
337 rm -f programs/test/cmake_package/cmake_package
338
339 # Remove any artifacts from the component_test_cmake_as_installed_package test.
340 rm -rf programs/test/cmake_package_install/build
341 rm -f programs/test/cmake_package_install/Makefile
342 rm -f programs/test/cmake_package_install/cmake_package_install
343
Gilles Peskinef83eb822020-03-30 20:11:39 +0200344 # Restore files that may have been clobbered by the job
345 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200346 if [[ -e "$x$backup_suffix" ]]; then
347 cp -p "$x$backup_suffix" "$x"
348 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200349 done
350}
John Durkopbd069d32020-10-31 22:14:03 -0700351
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200352# Final cleanup when this script exits (except when exiting on a failure
353# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200354final_cleanup () {
355 cleanup
356
357 for x in $files_to_back_up; do
358 rm -f "$x$backup_suffix"
359 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100360}
361
Gilles Peskine7c652162017-12-11 00:01:40 +0100362# Executed on exit. May be redefined depending on command line options.
363final_report () {
364 :
365}
366
367fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200368 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100369 final_report $1
370 trap - $1
371 kill -$1 $$
372}
373
374trap 'fatal_signal HUP' HUP
375trap 'fatal_signal INT' INT
376trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200377
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200378# Number of processors on this machine. Used as the default setting
379# for parallel make.
380all_sh_nproc ()
381{
382 {
383 nproc || # Linux
384 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
385 sysctl -n hw.ncpu || # FreeBSD
386 echo 1
387 } 2>/dev/null
388}
389
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100390msg()
391{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100392 if [ -n "${current_component:-}" ]; then
393 current_section="${current_component#component_}: $1"
394 else
395 current_section="$1"
396 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200397
398 if [ $QUIET -eq 1 ]; then
399 return
400 fi
401
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100402 echo ""
403 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100404 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000405 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo "******************************************************************"
407}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100408
Gilles Peskine8f073122018-11-27 15:58:47 +0100409armc6_build_test()
410{
411 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100412
Gilles Peskine18487f62020-04-30 23:11:54 +0200413 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800414 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100415 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000416 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200417
418 msg "size: ARM Compiler 6 ($FLAGS)"
419 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100420}
Andres AGa5cd9732016-10-17 15:23:10 +0100421
Andres AGd9eba4b2016-08-26 14:42:14 +0100422err_msg()
423{
424 echo "$1" >&2
425}
426
427check_tools()
428{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200429 for tool in "$@"; do
430 if ! `type "$tool" >/dev/null 2>&1`; then
431 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100432 exit 1
433 fi
434 done
435}
436
Gilles Peskine8f073122018-11-27 15:58:47 +0100437pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000438 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100439 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100440 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100441 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200442 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000443 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100444
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000445 # Note that legacy options are ignored instead of being omitted from this
446 # list of options, so invocations that worked with previous version of
447 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100448 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100449 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200450 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200451 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200452 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000453 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100454 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
455 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100456 --clang-earliest) shift; CLANG_EARLIEST="$1";;
457 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100458 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000459 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100460 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100461 --gcc-earliest) shift; GCC_EARLIEST="$1";;
462 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100463 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200464 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
465 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100466 --gnutls-serv) shift; GNUTLS_SERV="$1";;
467 --help|-h) usage; exit;;
468 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000469 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100470 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100471 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200472 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000473 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100474 --no-force) FORCE=0;;
475 --no-keep-going) KEEP_GOING=0;;
476 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200477 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100479 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200480 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200482 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200484 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200485 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --seed|-s) shift; SEED="$1";;
487 -*)
488 echo >&2 "Unknown option: $1"
489 echo >&2 "Run $0 --help for usage."
490 exit 120
491 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000492 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 esac
494 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100495 done
SimonB2e23c822016-04-16 21:54:39 +0100496
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100497 # Exclude components that are not supported on this platform.
498 SUPPORTED_COMPONENTS=
499 for component in $ALL_COMPONENTS; do
500 case $(type "support_$component" 2>&1) in
501 *' function'*)
502 if ! support_$component; then continue; fi;;
503 esac
504 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
505 done
506
507 if [ $list_components -eq 1 ]; then
508 printf '%s\n' $SUPPORTED_COMPONENTS
509 exit
510 fi
511
Gilles Peskinea28db922019-01-10 00:05:18 +0100512 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200513 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000514 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100515 fi
516
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000517 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
518 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100519 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000520 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100521 fi
SimonB2e23c822016-04-16 21:54:39 +0100522
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200523 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100524 if [ $all_except -eq 0 ]; then
525 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200526 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
527 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200528 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100529 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200530 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200531 # If the requested name includes a wildcard character, don't
532 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 case $component in
534 *[*?\[]*) continue;;
535 esac
536 case " $SUPPORTED_COMPONENTS " in
537 *" $component "*) :;;
538 *)
539 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
540 unsupported=$((unsupported + 1));;
541 esac
542 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200543 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100544 if [ $unsupported -ne 0 ]; then
545 exit 2
546 fi
547 fi
548
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000549 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100550 RUN_COMPONENTS=
551 for component in $SUPPORTED_COMPONENTS; do
552 if is_component_included "$component"; [ $? -eq $all_except ]; then
553 RUN_COMPONENTS="$RUN_COMPONENTS $component"
554 fi
555 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000556
557 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000558 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100559}
SimonB2e23c822016-04-16 21:54:39 +0100560
Gilles Peskine8f073122018-11-27 15:58:47 +0100561pre_check_git () {
562 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100563 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100564 git checkout-index -f -q $CONFIG_H
565 cleanup
566 else
SimonB2e23c822016-04-16 21:54:39 +0100567
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
569 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
570 echo "You can either delete this directory manually, or force the test by rerunning"
571 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
572 exit 1
573 fi
574
Ronald Cron7a93ac52023-07-20 09:49:12 +0200575 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100576 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100577 echo "You can either delete or preserve your work, or force the test by rerunning the"
578 echo "script as: $0 --force"
579 exit 1
580 fi
SimonB2e23c822016-04-16 21:54:39 +0100581 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500582}
583
Gilles Peskine568f53a2021-07-12 18:16:01 +0200584pre_restore_files () {
585 # If the makefiles have been generated by a framework such as cmake,
586 # restore them from git. If the makefiles look like modifications from
587 # the ones checked into git, take care not to modify them. Whatever
588 # this function leaves behind is what the script will restore before
589 # each component.
590 case "$(head -n1 Makefile)" in
591 *[Gg]enerated*)
592 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
593 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
594 ;;
595 esac
596}
597
Gilles Peskinef83eb822020-03-30 20:11:39 +0200598pre_back_up () {
599 for x in $files_to_back_up; do
600 cp -p "$x" "$x$backup_suffix"
601 done
602}
603
Gilles Peskine8f073122018-11-27 15:58:47 +0100604pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100605 failure_count=0 # Number of failed components
606 last_failure_status=0 # Last failure status in this component
607
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100608 # See err_trap
609 previous_failure_status=0
610 previous_failed_command=
611 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100612 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100613
Gilles Peskine7c652162017-12-11 00:01:40 +0100614 start_red=
615 end_color=
616 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100617 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
619 start_red=$(printf '\033[31m')
620 end_color=$(printf '\033[0m')
621 ;;
622 esac
623 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100624
625 # Keep a summary of failures in a file. We'll print it out at the end.
626 failure_summary_file=$PWD/all-sh-failures-$$.log
627 : >"$failure_summary_file"
628
629 # Whether it makes sense to keep a component going after the specified
630 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200631 # This function normally receives the failing simple command
632 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
633 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100634 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200635 # False positives result in running things that can't be expected to
636 # work. False negatives result in things not running after something else
637 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 can_keep_going_after_failure () {
639 case "$1" in
640 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200641 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100642 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200643 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
644 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
645 *make*check*) true;;
646 "grep "*) true;;
647 "[ "*) true;;
648 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100649 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100650 esac
651 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100652
653 # This function runs if there is any error in a component.
654 # It must either exit with a nonzero status, or set
655 # last_failure_status to a nonzero value.
656 err_trap () {
657 # Save $? (status of the failing command). This must be the very
658 # first thing, before $? is overridden.
659 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100660 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100661
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100662 if [[ $last_failure_status -eq $previous_failure_status &&
663 "$failed_command" == "$previous_failed_command" &&
664 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
665 then
666 # The same command failed twice in a row, but this time one level
667 # less deep in the function call stack. This happens when the last
668 # command of a function returns a nonzero status, and the function
669 # returns that same status. Ignore the second failure.
670 previous_failure_funcall_depth=${#FUNCNAME[@]}
671 return
672 fi
673 previous_failure_status=$last_failure_status
674 previous_failed_command=$failed_command
675 previous_failure_funcall_depth=${#FUNCNAME[@]}
676
Gilles Peskinece266c42020-03-28 18:50:43 +0100677 text="$current_section: $failed_command -> $last_failure_status"
678 echo "${start_red}^^^^$text^^^^${end_color}" >&2
679 echo "$text" >>"$failure_summary_file"
680
681 # If the command is fatal (configure or build command), stop this
682 # component. Otherwise (test command) keep the component running
683 # (run more tests from the same build).
684 if ! can_keep_going_after_failure "$failed_command"; then
685 exit $last_failure_status
686 fi
687 }
688
Gilles Peskine7c652162017-12-11 00:01:40 +0100689 final_report () {
690 if [ $failure_count -gt 0 ]; then
691 echo
692 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100693 echo "${start_red}FAILED: $failure_count components${end_color}"
694 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100695 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
696 elif [ -z "${1-}" ]; then
697 echo "SUCCESS :)"
698 fi
699 if [ -n "${1-}" ]; then
700 echo "Killed by SIG$1."
701 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100702 rm -f "$failure_summary_file"
703 if [ $failure_count -gt 0 ]; then
704 exit 1
705 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100706 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100707}
708
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200709# record_status() and if_build_succeeded() are kept temporarily for backward
710# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100711record_status () {
712 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100713}
Gilles Peskine7c652162017-12-11 00:01:40 +0100714if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100715 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100716}
717
Gilles Peskinea681c592020-03-28 21:27:40 +0100718# '! true' does not trigger the ERR trap. Arrange to trigger it, with
719# a reasonably informative error message (not just "$@").
720not () {
721 if "$@"; then
722 report_failed_command="! $*"
723 false
724 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200725 fi
726}
727
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200728pre_prepare_outcome_file () {
729 case "$MBEDTLS_TEST_OUTCOME_FILE" in
730 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
731 esac
732 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
733 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
734 fi
735}
736
Gilles Peskine8f073122018-11-27 15:58:47 +0100737pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200738 if [ $QUIET -eq 1 ]; then
739 return
740 fi
741
Gilles Peskine8f073122018-11-27 15:58:47 +0100742 msg "info: $0 configuration"
743 echo "MEMORY: $MEMORY"
744 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200745 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100747 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100748 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100749 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
750 echo "GNUTLS_CLI: $GNUTLS_CLI"
751 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
753 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
754}
Andres AG7770ea82016-10-10 15:46:20 +0100755
Andres AGd9eba4b2016-08-26 14:42:14 +0100756# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100757pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000758 # Build the list of variables to pass to output_env.sh.
759 set env
SimonB2e23c822016-04-16 21:54:39 +0100760
Gilles Peskine87964262019-01-06 22:40:00 +0000761 case " $RUN_COMPONENTS " in
762 # Require OpenSSL and GnuTLS if running any tests (as opposed to
763 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
764 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100765 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000766 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
767 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100768 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000769 export GNUTLS_CLI="$GNUTLS_CLI"
770 export GNUTLS_SERV="$GNUTLS_SERV"
771 # Avoid passing --seed flag in every call to ssl-opt.sh
772 if [ -n "${SEED-}" ]; then
773 export SEED
774 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200775 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000776 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200777 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
778 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000779 ;;
780 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200781
Gilles Peskine87964262019-01-06 22:40:00 +0000782 case " $RUN_COMPONENTS " in
783 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
784 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200787 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
791 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
792 esac
793
794 case " $RUN_COMPONENTS " in
795 *" test_zeroize "*) check_tools "gdb";;
796 esac
797
798 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000799 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000800 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
801 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200802 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000803 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
804 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200805 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
806 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
807 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000808 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000809
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200810 # past this point, no call to check_tool, only printing output
811 if [ $QUIET -eq 1 ]; then
812 return
813 fi
814
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000815 msg "info: output_env.sh"
816 case $RUN_COMPONENTS in
817 *_armcc*)
818 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
819 *) set "$@" RUN_ARMCC=0;;
820 esac
821 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100822}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100823
Gilles Peskine1570b592021-04-22 01:10:12 +0200824pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200825 # since make doesn't have proper dependencies, remove any possibly outdate
826 # file that might be around before generating fresh ones
827 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200828 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200829 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200830 else
831 make generated_files
832 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200833}
834
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000835clang_version() {
836 if command -v clang > /dev/null ; then
837 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
838 else
839 echo 0 # report version 0 for "no clang"
840 fi
841}
842
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200843################################################################
844#### Helpers for components using libtestdriver1
845################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100846
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200847# How to use libtestdriver1
848# -------------------------
849#
850# 1. Define the list algorithms and key types to accelerate,
851# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
852# Examples:
853# - loc_accel_list="ALG_JPAKE"
854# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200855# 2. Make configurations changes for the driver and/or main libraries.
856# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
857# can be either "default" to start with the default config, or a name
858# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200859# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200860# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
861# These changes affect both the driver and the main libraries.
862# (Note: they need to have the same set of PSA_WANT symbols, as that
863# determines the ABI between them.)
864# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
865# main libraries. Typically, you want to disable the module(s) that are
866# being accelerated. You may need to also disable modules that depend
867# on them or options that are not supported with drivers.
868# 2d. On top of psa/crypto_config.h, the driver library uses its own config
869# file: tests/include/test/drivers/config_test_driver.h. You usually
870# don't need to edit it: using loc_extra_list (see below) is preferred.
871# However, when there's no PSA symbol for what you want to enable,
872# calling scripts/config.py on this file remains the only option.
873# 3. Build the driver library, then the main libraries, test, and programs.
874# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
875# need to enable more algorithms here, typically hash algorithms when
876# accelerating some signature algorithms (ECDSA, RSAv2). This is done
877# by passing a 2nd argument listing the extra algorithms.
878# Example:
879# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
880# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800881# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200882# additional arguments will be passed to make: this can be useful if
883# you don't want to build everything when iterating during development.
884# Example:
885# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
886# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200887
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200888# Adjust the configuration - for both libtestdriver1 and main library,
889# as they should have the same PSA_WANT macros.
890helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200891 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200892 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200893 if [ "$base_config" != "default" ]; then
894 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200895 fi
896
897 # Enable PSA-based config (necessary to use drivers)
898 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
899
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200900 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
901 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
902 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000903
904 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
905 # otherwise we will end up running multithreaded tests without mutexes to protect them.
906 if scripts/config.py get MBEDTLS_THREADING_C; then
907 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
908 fi
909
910 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
912 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200913}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100914
Valerio Settib2fd6732023-08-15 17:10:47 +0200915# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200916# The function optionally accepts 1 parameter: a space-separated list of the
917# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200918helper_disable_builtin_curves() {
919 allowed_list="${1:-}"
920 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
921
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200922 for curve in $allowed_list; do
923 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200924 done
925}
926
927# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
928# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
929# in the following helpers.
930helper_get_psa_curve_list () {
931 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200932 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
933 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200934 done
935
936 echo "$loc_list"
937}
938
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100939# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
940# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
941# in the following helpers.
942helper_get_psa_dh_group_list () {
943 loc_list=""
944 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
945 loc_list="$loc_list $item"
946 done
947
948 echo "$loc_list"
949}
950
Valerio Settib2fd6732023-08-15 17:10:47 +0200951# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200952# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200953# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200954helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200955 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200956 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200957 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 +0200958 # Skip DERIVE for elliptic keys since there is no driver dispatch for
959 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200960 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
961 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200962 fi
963 done
964
965 echo "$loc_list"
966}
967
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200968# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200969#
970# Parameters:
971# 1. a space-separated list of things to accelerate;
972# 2. optional: a space-separate list of things to also support.
973# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
974helper_libtestdriver1_make_drivers() {
975 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100976 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200977}
978
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200979# Build the main libraries, programs and tests,
980# linking to the drivers library (with ASan).
981#
982# Parameters:
983# 1. a space-separated list of things to accelerate;
984# *. remaining arguments if any are passed directly to make
985# (examples: lib, -C tests test_suite_xxx, etc.)
986# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
987helper_libtestdriver1_make_main() {
988 loc_accel_list=$1
989 shift
990
991 # we need flags both with and without the LIBTESTDRIVER1_ prefix
992 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
993 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100994 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" "$@"
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200995}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100996
997################################################################
998#### Basic checks
999################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001000
1001#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001002# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001003#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001004# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001005# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001006# 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 +02001007# time, so start with a GCC build).
1008# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001009#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001010# Indicative running times are given for reference.
1011
Gilles Peskine8f073122018-11-27 15:58:47 +01001012component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001013 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001014 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001015}
Janos Follathb72c6782016-07-19 14:54:17 +01001016
Gilles Peskine67debb62021-05-18 16:09:50 +02001017component_check_generated_files () {
1018 msg "Check: check-generated-files, files generated with make" # 2s
1019 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001020 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001021
1022 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001023 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001024 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001025 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001026
1027 msg "Check: check-generated-files -u, files absent" # 2s
1028 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001029 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001030 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001031 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001032
1033 # This component ends with the generated files present in the source tree.
1034 # This is necessary for subsequent components!
1035}
1036
Gilles Peskine8f073122018-11-27 15:58:47 +01001037component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001038 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001039 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001040}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001041
Gilles Peskine8f073122018-11-27 15:58:47 +01001042component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001043 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001044 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001045}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001047component_check_changelog () {
1048 msg "Check: changelog entries" # < 1s
1049 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001050 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001051 if [ -e ChangeLog.new ]; then
1052 # Show the diff for information. It isn't an error if the diff is
1053 # non-empty.
1054 diff -u ChangeLog ChangeLog.new || true
1055 rm ChangeLog.new
1056 fi
1057}
1058
Gilles Peskine8f073122018-11-27 15:58:47 +01001059component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001060 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001061 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001062}
Darryl Greena07039c2018-03-13 16:48:16 +00001063
Gilles Peskine895868b2019-09-19 21:30:05 +02001064component_check_test_cases () {
1065 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001066 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001067 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001068 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001069 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001070 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001071 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001072 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001073}
1074
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001075component_check_test_dependencies () {
1076 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001077 # The purpose of this component is to catch unjustified dependencies on
1078 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1079 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1080 # MBEDTLS_PSA_xxx).
1081 #
1082 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1083 # this component is meant to catch. However a few of them are justified,
1084 # mostly by the absence of a PSA equivalent, so this component includes a
1085 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001086
1087 found="check-test-deps-found-$$"
1088 expected="check-test-deps-expected-$$"
1089
1090 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001091 grep 'depends_on' \
1092 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001093 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001094 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001095 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001096
Yanray Wang18040ed2023-11-23 21:29:56 +08001097 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001098 rm -f $expected
1099 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1100 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001101 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1102 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001103 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1104 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001105 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1106 # the test code and that's probably the most convenient way of achieving
1107 # the test's goal.
1108 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1109 # No PSA equivalent - we should probably have one in the future.
1110 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1111 # No PSA equivalent - needed by some init tests
1112 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001113 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001114 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001115
1116 # Compare reality with expectation.
1117 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001118 #
1119 # The output should be empty. When it's not:
1120 # - Each '+' line is a macro that was found but not expected. You want to
1121 # find where that macro occurs, and either replace it with PSA macros, or
1122 # add it to the exceptions list above with a justification.
1123 # - Each '-' line is a macro that was expected but not found; it means the
1124 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001125 diff -U0 $expected $found
1126
1127 rm $found $expected
1128}
1129
Gilles Peskine8f073122018-11-27 15:58:47 +01001130component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001131 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001132 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001133}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001134
Gilles Peskine192c72f2017-12-21 15:59:21 +01001135
Gilles Peskine636c26a2020-03-04 20:46:15 +01001136
Gilles Peskine192c72f2017-12-21 15:59:21 +01001137################################################################
1138#### Build and test many configurations and targets
1139################################################################
1140
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001141component_test_default_out_of_box () {
1142 msg "build: make, default config (out-of-box)" # ~1min
1143 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001144 # Disable fancy stuff
1145 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001146
1147 msg "test: main suites make, default config (out-of-box)" # ~10s
1148 make test
1149
1150 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001151 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001152
1153 msg "program demos: make, default config (out-of-box)" # ~10s
1154 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001155}
1156
Gilles Peskine8f073122018-11-27 15:58:47 +01001157component_test_default_cmake_gcc_asan () {
1158 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001159 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1160 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001161
Gilles Peskine8f073122018-11-27 15:58:47 +01001162 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1163 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001164
Gilles Peskine82b27272019-06-14 18:27:03 +02001165 msg "program demos (ASan build)" # ~10s
1166 tests/scripts/run_demos.py
1167
Gilles Peskine97bea012020-04-23 23:37:45 +02001168 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001169 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001170
Gilles Peskine6848d172023-11-02 19:58:03 +01001171 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001172 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001173
Gilles Peskine8f073122018-11-27 15:58:47 +01001174 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001175 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001176
Gilles Peskine8f073122018-11-27 15:58:47 +01001177 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001178 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001179
1180 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001181 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001182}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001183
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001184component_test_default_cmake_gcc_asan_new_bignum () {
1185 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001186 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001187 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001188 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001189
1190 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1191 make test
1192
1193 msg "test: selftest (ASan build)" # ~ 10s
1194 programs/test/selftest
1195
1196 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1197 tests/ssl-opt.sh
1198
1199 msg "test: compat.sh (ASan build)" # ~ 6 min
1200 tests/compat.sh
1201
1202 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1203 tests/context-info.sh
1204}
1205
Hanno Becker01635512019-02-26 14:27:09 +00001206component_test_full_cmake_gcc_asan () {
1207 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001208 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001209 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1210 make
1211
1212 msg "test: main suites (inc. selftests) (full config, ASan build)"
1213 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001214
Gilles Peskine97bea012020-04-23 23:37:45 +02001215 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001216 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001217
Gilles Peskine636c26a2020-03-04 20:46:15 +01001218 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001219 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001220
1221 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001222 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001223
1224 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001225 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001226}
1227
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001228
1229component_test_full_cmake_gcc_asan_new_bignum () {
1230 msg "build: full config, cmake, gcc, ASan"
1231 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001232 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001233 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001234 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001235
1236 msg "test: main suites (inc. selftests) (full config, ASan build)"
1237 make test
1238
1239 msg "test: selftest (ASan build)" # ~ 10s
1240 programs/test/selftest
1241
1242 msg "test: ssl-opt.sh (full config, ASan build)"
1243 tests/ssl-opt.sh
1244
1245 msg "test: compat.sh (full config, ASan build)"
1246 tests/compat.sh
1247
1248 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1249 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001250}
1251
Ronald Cronc3623db2020-10-29 10:51:32 +01001252component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001253 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001254 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001255 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1256 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1257 make
1258
1259 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1260 make test
1261}
1262
David Horstmann4a48bec2024-03-13 15:42:31 +00001263component_test_psa_assume_exclusive_buffers () {
1264 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001265 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001266 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001267 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1268 make
1269
David Horstmann4a48bec2024-03-13 15:42:31 +00001270 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001271 make test
1272}
1273
Gilles Peskinea3548672021-06-17 11:37:52 +02001274# check_renamed_symbols HEADER LIB
1275# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1276# name is LIB.
1277check_renamed_symbols () {
1278 ! nm "$2" | sed 's/.* //' |
1279 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1280}
1281
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001282component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001283 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001284 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001285 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1286 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1287 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1288 # We can only compile, not link, since our test and sample programs
1289 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1290 # is active.
1291 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001292
1293 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1294 # version is not present.
1295 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001296 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001297}
1298
Valerio Setti63097752024-03-12 13:18:13 +01001299# Get a list of library-wise undefined symbols and ensure that they only
1300# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1301# This function is a common helper used by both:
1302# - component_test_default_psa_crypto_client_without_crypto_provider
1303# - component_build_full_psa_crypto_client_without_crypto_provider.
1304common_check_mbedtls_missing_symbols() {
1305 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1306 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1307 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1308 not grep mbedtls_ linking_errors.txt
1309
1310 rm sym_def.txt sym_undef.txt linking_errors.txt
1311}
1312
1313component_test_default_psa_crypto_client_without_crypto_provider () {
1314 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1315
Ronald Cron336678b2021-01-28 17:54:24 +01001316 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1317 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001318 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001319 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001320 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001321 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001322
Ronald Cron336678b2021-01-28 17:54:24 +01001323 make
1324
Valerio Setti63097752024-03-12 13:18:13 +01001325 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1326 common_check_mbedtls_missing_symbols
1327
1328 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001329 make test
1330}
1331
Valerio Setti63097752024-03-12 13:18:13 +01001332component_build_full_psa_crypto_client_without_crypto_provider () {
1333 msg "build: full config - PSA_CRYPTO_C"
1334
1335 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1336 scripts/config.py full
1337
1338 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1339 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1340 # Dynamic secure element support is a deprecated feature and it is not
1341 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1342 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1343
1344 # Since there is no crypto provider in this build it is not possible to
1345 # build all the test executables and progrems due to missing PSA functions
1346 # at link time. Therefore we will just build libraries and we'll check
1347 # that symbols of interest are there.
1348 make lib
1349
1350 msg "check missing symbols: full config - PSA_CRYPTO_C"
1351
1352 common_check_mbedtls_missing_symbols
1353
1354 # Ensure that desired functions are included into the build (extend the
1355 # following list as required).
1356 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1357 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1358 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1359}
1360
Jaeden Amero424fa932021-05-14 08:34:32 +01001361component_test_psa_crypto_rsa_no_genprime() {
1362 msg "build: default config minus MBEDTLS_GENPRIME"
1363 scripts/config.py unset MBEDTLS_GENPRIME
1364 make
1365
1366 msg "test: default config minus MBEDTLS_GENPRIME"
1367 make test
1368}
1369
Gilles Peskine782f4112018-11-27 16:11:09 +01001370component_test_ref_configs () {
1371 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001372 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1373 # want to re-generate generated files that depend on it, quite correctly.
1374 # However this doesn't work as the generation script expects a specific
1375 # format for mbedtls_config.h, which the other files don't follow. Also,
1376 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001377 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001378 # whether they're on or off. So, disable cmake's (over-sensitive here)
1379 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001380 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001381 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001382 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001383}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001384
Gilles Peskine8f073122018-11-27 15:58:47 +01001385component_test_no_renegotiation () {
1386 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001387 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001388 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001389 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001390
Gilles Peskine8f073122018-11-27 15:58:47 +01001391 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1392 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001393
Gilles Peskine8f073122018-11-27 15:58:47 +01001394 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001395 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001396}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001397
Gilles Peskine636c26a2020-03-04 20:46:15 +01001398component_test_no_pem_no_fs () {
1399 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1400 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1401 scripts/config.py unset MBEDTLS_FS_IO
1402 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1403 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001404 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001405 make
1406
1407 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1408 make test
1409
1410 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001411 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001412}
1413
Gilles Peskine8f073122018-11-27 15:58:47 +01001414component_test_rsa_no_crt () {
1415 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001416 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001417 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001418 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001419
Gilles Peskine8f073122018-11-27 15:58:47 +01001420 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1421 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001422
Gilles Peskine8f073122018-11-27 15:58:47 +01001423 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001424 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001425
Gilles Peskine8f073122018-11-27 15:58:47 +01001426 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001427 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001428
1429 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001430 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001431}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001432
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001433component_test_no_ctr_drbg_classic () {
1434 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001435 scripts/config.py full
1436 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001437 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001438 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001439
Dave Rodgman17127e92023-12-14 16:42:48 +00001440 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001441 make
1442
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001443 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001444 make test
1445
Gilles Peskineba749042021-01-13 20:02:03 +01001446 # In this configuration, the TLS test programs use HMAC_DRBG.
1447 # The SSL tests are slow, so run a small subset, just enough to get
1448 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001449 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001450 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001451
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001452 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001453 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001454}
1455
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001456component_test_no_ctr_drbg_use_psa () {
1457 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001458 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001459 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1460 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001461
Dave Rodgman17127e92023-12-14 16:42:48 +00001462 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001463 make
1464
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001465 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1466 make test
1467
1468 # In this configuration, the TLS test programs use HMAC_DRBG.
1469 # The SSL tests are slow, so run a small subset, just enough to get
1470 # confidence that the SSL code copes with HMAC_DRBG.
1471 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001472 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001473
1474 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001475 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001476}
1477
1478component_test_no_hmac_drbg_classic () {
1479 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1480 scripts/config.py full
1481 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1482 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1483 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001484 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001485
Dave Rodgman17127e92023-12-14 16:42:48 +00001486 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001487 make
1488
1489 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001490 make test
1491
Gilles Peskinea2224342020-11-19 22:14:34 +01001492 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1493 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1494 # instead.
1495 # Test SSL with non-deterministic ECDSA. Only test features that
1496 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001497 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001498 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001499
1500 # To save time, only test one protocol version, since this part of
1501 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001503 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001504}
1505
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001506component_test_no_hmac_drbg_use_psa () {
1507 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1508 scripts/config.py full
1509 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1510 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1511 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1512
Dave Rodgman17127e92023-12-14 16:42:48 +00001513 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001514 make
1515
1516 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1517 make test
1518
1519 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1520 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1521 # instead.
1522 # Test SSL with non-deterministic ECDSA. Only test features that
1523 # might be affected by how ECDSA signature is performed.
1524 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001525 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001526
1527 # To save time, only test one protocol version, since this part of
1528 # the protocol is identical in (D)TLS up to 1.2.
1529 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001530 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001531}
1532
1533component_test_psa_external_rng_no_drbg_classic () {
1534 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1535 scripts/config.py full
1536 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001537 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001538 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001539 scripts/config.py unset MBEDTLS_ENTROPY_C
1540 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1541 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001542 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1543 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1544 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001545 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1546 # the SSL test programs don't have an RNG and can't work. Explicitly
1547 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001548 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001549
1550 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1551 make test
1552
Gilles Peskine8eb29432021-02-03 20:07:11 +01001553 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001554 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555}
1556
1557component_test_psa_external_rng_no_drbg_use_psa () {
1558 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001559 scripts/config.py full
1560 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001561 scripts/config.py unset MBEDTLS_ENTROPY_C
1562 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1563 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001564 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1565 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1566 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001567 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001568
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001569 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001570 make test
1571
Gilles Peskine8eb29432021-02-03 20:07:11 +01001572 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001573 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001574}
1575
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001576component_test_psa_external_rng_use_psa_crypto () {
1577 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1578 scripts/config.py full
1579 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1580 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1581 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001582 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001583
1584 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1585 make test
1586
1587 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1588 tests/ssl-opt.sh -f 'Default\|opaque'
1589}
1590
Gilles Peskine801c4332023-04-28 21:04:28 +02001591component_test_psa_inject_entropy () {
1592 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1593 scripts/config.py full
1594 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1595 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1596 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1597 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1598 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1599 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001600 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 +02001601
1602 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1603 make test
1604}
1605
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001606component_test_sw_inet_pton () {
1607 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1608
1609 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1610 scripts/config.py set MBEDTLS_TEST_HOOKS
1611 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1612
1613 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1614 make test
1615}
1616
Valerio Settia41654d2024-02-08 10:33:11 +01001617component_full_no_pkparse_pkwrite() {
1618 msg "build: full without pkparse and pkwrite"
1619
1620 scripts/config.py crypto_full
1621 scripts/config.py unset MBEDTLS_PK_PARSE_C
1622 scripts/config.py unset MBEDTLS_PK_WRITE_C
1623
Valerio Settia41654d2024-02-08 10:33:11 +01001624 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1625
1626 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1627 not grep mbedtls_pk_parse_key library/pkparse.o
1628 not grep mbedtls_pk_write_key_der library/pkwrite.o
1629
1630 msg "test: full without pkparse and pkwrite"
1631 make test
1632}
1633
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001634component_test_crypto_full_md_light_only () {
1635 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001636 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001637 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001638 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001639 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001640 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001641 scripts/config.py unset MBEDTLS_HKDF_C
1642 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001643 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001644 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001645 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001646 # Disable things that would auto-enable MD_C
1647 scripts/config.py unset MBEDTLS_PKCS5_C
1648
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001649 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1650 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001651 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001652
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001653 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001654 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001655 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001656
1657 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001658 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001659}
1660
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001661component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001662 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001663 scripts/config.py full
1664 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001665 # Don't pull in cipher via PSA mechanisms
1666 # (currently ignored anyway because we completely disable PSA)
1667 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001668 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001669 scripts/config.py unset MBEDTLS_CMAC_C
1670 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001671 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001672 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001673 scripts/config.py unset MBEDTLS_SSL_TLS_C
1674 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001675 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001676 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1677 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001678 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001679 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001680 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001681
Valerio Settidf17a102023-10-23 14:14:19 +02001682 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001683 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001684}
1685
Valerio Setti7e710e82023-08-25 09:14:15 +02001686# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001687# - component_test_full_no_cipher_with_psa_crypto
1688# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001689# It accepts 2 input parameters:
1690# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1691# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001692common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001693 USE_CRYPTO_CONFIG="$1"
1694 COMPONENT_DESCRIPTION="$2"
1695
1696 msg "build: $COMPONENT_DESCRIPTION"
1697
1698 scripts/config.py full
1699 scripts/config.py unset MBEDTLS_CIPHER_C
1700
1701 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001702 # The built-in implementation of the following algs/key-types depends
1703 # on CIPHER_C so we disable them.
1704 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1705 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001706 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001707 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1708 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1709 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1710 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1711 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1712 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1713 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1714 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001715 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001716 else
1717 # Don't pull in cipher via PSA mechanisms
1718 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001719 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1720 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1721 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001722 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001723 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001724 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001725 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001726
Gilles Peskine21570cf2023-12-22 11:49:50 +01001727 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001728
Valerio Setti7e710e82023-08-25 09:14:15 +02001729 # Ensure that CIPHER_C was not re-enabled
1730 not grep mbedtls_cipher_init library/cipher.o
1731
1732 msg "test: $COMPONENT_DESCRIPTION"
1733 make test
1734}
1735
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001736component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001737 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001738}
1739
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001740component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001741 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001742}
1743
Valerio Settibdfecb62023-11-07 15:37:20 +01001744component_test_full_no_ccm() {
1745 msg "build: full no PSA_WANT_ALG_CCM"
1746
1747 # Full config enables:
1748 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1749 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1750 scripts/config.py full
1751
1752 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1753 # enabled, but not used from TLS since USE_PSA is set.
1754 # This is helpful to ensure that TLS tests below have proper dependencies.
1755 #
1756 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1757 # PSA_WANT_ALG_CCM to be re-enabled.
1758 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1759
Gilles Peskine21570cf2023-12-22 11:49:50 +01001760 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001761
1762 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001763 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001764}
1765
1766component_test_full_no_ccm_star_no_tag() {
1767 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1768
1769 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1770 scripts/config.py full
1771
1772 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1773 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1774 # This basically disables all unauthenticated ciphers on the PSA side, while
1775 # keeping AEADs enabled.
1776 #
1777 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1778 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1779 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1780 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1781 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1782 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1783 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1784 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1785 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1786 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1787
Gilles Peskine21570cf2023-12-22 11:49:50 +01001788 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001789
1790 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001791 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001792
1793 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001794 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001795}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001796
Valerio Settie1655b82023-01-03 15:35:25 +01001797component_test_full_no_bignum () {
1798 msg "build: full minus bignum"
1799 scripts/config.py full
1800 scripts/config.py unset MBEDTLS_BIGNUM_C
1801 # Direct dependencies of bignum
1802 scripts/config.py unset MBEDTLS_ECP_C
1803 scripts/config.py unset MBEDTLS_RSA_C
1804 scripts/config.py unset MBEDTLS_DHM_C
1805 # Direct dependencies of ECP
1806 scripts/config.py unset MBEDTLS_ECDH_C
1807 scripts/config.py unset MBEDTLS_ECDSA_C
1808 scripts/config.py unset MBEDTLS_ECJPAKE_C
1809 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001810 # Disable what auto-enables ECP_LIGHT
1811 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1812 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001813 # Indirect dependencies of ECP
1814 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1815 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1816 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1817 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1818 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1819 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1820 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1821 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1822 # Direct dependencies of DHM
1823 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1824 # Direct dependencies of RSA
1825 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1826 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1827 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1828 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1829 # PK and its dependencies
1830 scripts/config.py unset MBEDTLS_PK_C
1831 scripts/config.py unset MBEDTLS_PK_PARSE_C
1832 scripts/config.py unset MBEDTLS_PK_WRITE_C
1833 scripts/config.py unset MBEDTLS_X509_USE_C
1834 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1835 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1836 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1837 scripts/config.py unset MBEDTLS_X509_CREATE_C
1838 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1839 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1840 scripts/config.py unset MBEDTLS_PKCS7_C
1841 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1842 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1843 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1844
Gilles Peskine21570cf2023-12-22 11:49:50 +01001845 make
Valerio Settie1655b82023-01-03 15:35:25 +01001846
1847 msg "test: full minus bignum"
1848 make test
1849}
1850
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001851component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001852 msg "build: default with only stream cipher"
1853
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001854 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001855 scripts/config.py unset MBEDTLS_GCM_C
1856 scripts/config.py unset MBEDTLS_CCM_C
1857 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001858 #Disable TLS 1.3 (as no AEAD)
1859 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001860 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001861 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001862 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001863 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001864 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1865 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001866 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001867 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001868 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001869
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001870 make
1871
1872 msg "test: default with only stream cipher"
1873 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001874
1875 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001876}
1877
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001878component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001879 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001880
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001881 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001882 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001883 scripts/config.py unset MBEDTLS_GCM_C
1884 scripts/config.py unset MBEDTLS_CCM_C
1885 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001886 #Disable TLS 1.3 (as no AEAD)
1887 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001888 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel9550c052022-09-28 09:51:55 +02001889 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001890 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001891 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001892 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1893 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001894 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001895 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001896 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001897
Przemek Stekiel9550c052022-09-28 09:51:55 +02001898 make
1899
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001900 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001901 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001902
1903 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001904}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001905
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001906component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001907 msg "build: default with only CBC-legacy cipher"
1908
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001909 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001910 scripts/config.py unset MBEDTLS_GCM_C
1911 scripts/config.py unset MBEDTLS_CCM_C
1912 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001913 #Disable TLS 1.3 (as no AEAD)
1914 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001915 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1916 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1917 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001918 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001919 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001920 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001921 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001922 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001923 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001924
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001925 make
1926
1927 msg "test: default with only CBC-legacy cipher"
1928 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001929
1930 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1931 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001932}
1933
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001934component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001935 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001936
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001937 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001938 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001939 scripts/config.py unset MBEDTLS_GCM_C
1940 scripts/config.py unset MBEDTLS_CCM_C
1941 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001942 #Disable TLS 1.3 (as no AEAD)
1943 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001944 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1945 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1946 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001947 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001948 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001949 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001950 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001951 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001952 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001953
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001954 make
1955
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001956 msg "test: default with only CBC-legacy cipher use psa"
1957 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001958
1959 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1960 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001961}
1962
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001963component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001964 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1965
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001966 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001967 scripts/config.py unset MBEDTLS_GCM_C
1968 scripts/config.py unset MBEDTLS_CCM_C
1969 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001970 #Disable TLS 1.3 (as no AEAD)
1971 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001972 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1973 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1974 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1975 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1976 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001977 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001978 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001979 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001980 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001981
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001982 make
1983
1984 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1985 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001986
1987 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1988 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001989}
1990
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001991component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1992 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001993
1994 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001995 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001996 scripts/config.py unset MBEDTLS_GCM_C
1997 scripts/config.py unset MBEDTLS_CCM_C
1998 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001999 #Disable TLS 1.3 (as no AEAD)
2000 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002001 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2002 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2003 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2004 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2005 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002006 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002007 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002008 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002009 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002010
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002011 make
2012
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002013 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002014 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002015
2016 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2017 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002018}
2019
Valerio Setti9f0ec532022-11-08 13:03:24 +01002020# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2021# that we could use for interop testing. However, we now have sort of two
2022# implementations ourselves: one using PSA, the other not. At least test that
2023# these two interoperate with each other.
2024component_test_tls1_2_ecjpake_compatibility() {
2025 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2026 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002027 # Explicitly make lib first to avoid a race condition:
2028 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2029 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002030 make -C programs ssl/ssl_server2 ssl/ssl_client2
2031 cp programs/ssl/ssl_server2 s2_no_use_psa
2032 cp programs/ssl/ssl_client2 c2_no_use_psa
2033
2034 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2035 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2036 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002037 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002038 make -C programs ssl/ssl_server2 ssl/ssl_client2
2039 make -C programs test/udp_proxy test/query_compile_time_config
2040
Valerio Setti70e02902022-12-02 16:21:56 +01002041 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2042 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2043 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2044 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2045 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2046 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2047 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2048 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 +01002049
2050 rm s2_no_use_psa c2_no_use_psa
2051}
2052
Gilles Peskine636c26a2020-03-04 20:46:15 +01002053component_test_everest () {
2054 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2055 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2056 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2057 make
2058
2059 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2060 make test
2061
Gilles Peskine6848d172023-11-02 19:58:03 +01002062 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002063 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002064
Gilles Peskine636c26a2020-03-04 20:46:15 +01002065 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2066 tests/ssl-opt.sh -f ECDH
2067
2068 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2069 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002070 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002071}
2072
Gilles Peskined3beca92020-07-03 00:15:37 +02002073component_test_everest_curve25519_only () {
2074 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002075 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2076 scripts/config.py unset MBEDTLS_ECDSA_C
2077 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2078 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002079 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002080 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002081 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002082 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2083
Dave Rodgman17127e92023-12-14 16:42:48 +00002084 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002085
2086 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2087 make test
2088}
2089
Gilles Peskine8f073122018-11-27 15:58:47 +01002090component_test_small_ssl_out_content_len () {
2091 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002092 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2093 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002094 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002095 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002096
Gilles Peskine8f073122018-11-27 15:58:47 +01002097 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002098 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002099}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002100
Gilles Peskine8f073122018-11-27 15:58:47 +01002101component_test_small_ssl_in_content_len () {
2102 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002103 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2104 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002105 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002106 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002107
Gilles Peskine8f073122018-11-27 15:58:47 +01002108 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002109 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002110}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002111
Gilles Peskine8f073122018-11-27 15:58:47 +01002112component_test_small_ssl_dtls_max_buffering () {
2113 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002114 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002115 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002116 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002117
Gilles Peskine8f073122018-11-27 15:58:47 +01002118 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002119 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 +01002120}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002121
Gilles Peskine8f073122018-11-27 15:58:47 +01002122component_test_small_mbedtls_ssl_dtls_max_buffering () {
2123 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002124 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002125 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002126 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002127
Gilles Peskine8f073122018-11-27 15:58:47 +01002128 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002129 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002130}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002131
Gilles Peskine75cc7712019-09-06 19:47:17 +02002132component_test_psa_collect_statuses () {
2133 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002134 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002135 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002136 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002137 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002138 rm -f tests/statuses.log
2139}
2140
Gilles Peskine8f073122018-11-27 15:58:47 +01002141component_test_full_cmake_clang () {
2142 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002143 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002144 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 +01002145 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002146
k-stachowiak0291cb72019-06-26 15:52:12 +02002147 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002148 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002149
Gilles Peskineda6017c2022-10-30 21:02:40 +01002150 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2151 programs/test/cpp_dummy_build
2152
Gilles Peskine6848d172023-11-02 19:58:03 +01002153 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002154 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002155
Gilles Peskine82b27272019-06-14 18:27:03 +02002156 msg "program demos (full config, clang)" # ~10s
2157 tests/scripts/run_demos.py
2158
k-stachowiak0291cb72019-06-26 15:52:12 +02002159 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002160 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002161
Gilles Peskine8f073122018-11-27 15:58:47 +01002162 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002163 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002164
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002165 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002166 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002167
Gilles Peskine8f073122018-11-27 15:58:47 +01002168 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002169 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002170}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002171
Gilles Peskine0c671602022-11-29 16:01:41 +01002172skip_suites_without_constant_flow () {
2173 # Skip the test suites that don't have any constant-flow annotations.
2174 # This will need to be adjusted if we ever start declaring things as
2175 # secret from macros or functions inside tests/include or tests/src.
2176 SKIP_TEST_SUITES=$(
2177 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2178 sed 's/test_suite_//; s/\.function$//' |
2179 tr '\n' ,)
2180 export SKIP_TEST_SUITES
2181}
2182
Dave Rodgman246210e2023-07-31 18:07:44 +01002183skip_all_except_given_suite () {
2184 # Skip all but the given test suite
2185 SKIP_TEST_SUITES=$(
2186 ls -1 tests/suites/test_suite_*.function |
2187 grep -v $1.function |
2188 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2189 tr '\n' ,)
2190 export SKIP_TEST_SUITES
2191}
2192
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002193component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002194 # This tests both (1) accesses to undefined memory, and (2) branches or
2195 # memory access depending on secret values. To distinguish between those:
2196 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2197 # - or alternatively, change the build type to MemSanDbg, which enables
2198 # origin tracking and nicer stack traces (which are useful for debugging
2199 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002200 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2201 scripts/config.py full
2202 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2203 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2204 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2205 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2206 make
2207
2208 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2209 make test
2210}
2211
2212component_test_memsan_constant_flow_psa () {
2213 # This tests both (1) accesses to undefined memory, and (2) branches or
2214 # memory access depending on secret values. To distinguish between those:
2215 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2216 # - or alternatively, change the build type to MemSanDbg, which enables
2217 # origin tracking and nicer stack traces (which are useful for debugging
2218 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002219 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002220 scripts/config.py full
2221 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2222 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2223 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2224 make
2225
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002226 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002227 make test
2228}
2229
Bence Szépkúti0354d042023-12-06 16:14:37 +01002230component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002231 # This tests both (1) everything that valgrind's memcheck usually checks
2232 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2233 # etc.) and (2) branches or memory access depending on secret values,
2234 # which will be reported as uninitialized memory. To distinguish between
2235 # secret and actually uninitialized:
2236 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2237 # - or alternatively, build with debug info and manually run the offending
2238 # test suite with valgrind --track-origins=yes, then check if the origin
2239 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002240 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2241 scripts/config.py full
2242 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2243 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002244 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002245 cmake -D CMAKE_BUILD_TYPE:String=Release .
2246 make
2247
2248 # this only shows a summary of the results (how many of each type)
2249 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002250 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002251 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002252
2253 # Test asm path in constant time module - by default, it will test the plain C
2254 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2255 msg "test: valgrind asm constant_time"
2256 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2257 skip_all_except_given_suite test_suite_constant_time
2258 cmake -D CMAKE_BUILD_TYPE:String=Release .
2259 make clean
2260 make
2261 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002262}
2263
Bence Szépkúti0354d042023-12-06 16:14:37 +01002264component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002265 # This tests both (1) everything that valgrind's memcheck usually checks
2266 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2267 # etc.) and (2) branches or memory access depending on secret values,
2268 # which will be reported as uninitialized memory. To distinguish between
2269 # secret and actually uninitialized:
2270 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2271 # - or alternatively, build with debug info and manually run the offending
2272 # test suite with valgrind --track-origins=yes, then check if the origin
2273 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002274 msg "build: cmake release GCC, full config with constant flow testing"
2275 scripts/config.py full
2276 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002277 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002278 cmake -D CMAKE_BUILD_TYPE:String=Release .
2279 make
2280
2281 # this only shows a summary of the results (how many of each type)
2282 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002283 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002284 make memcheck
2285}
2286
Janos Follath9338cac2023-10-04 18:55:39 +01002287component_test_tsan () {
2288 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002289 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002290 scripts/config.py set MBEDTLS_THREADING_C
2291 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002292 # Self-tests do not currently use multiple threads.
2293 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002294
Ryan6caf84f2024-03-05 13:57:00 +00002295 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2296 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2297
Janos Follath9338cac2023-10-04 18:55:39 +01002298 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2299 make
2300
2301 msg "test: main suites (TSan)"
2302 make test
2303}
2304
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002305component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002306 # Test that removing the deprecated features from the default
2307 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002308 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2309 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002310 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002311
2312 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2313 make test
2314}
2315
2316component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002317 msg "build: make, full_no_deprecated config" # ~ 30s
2318 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002319 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002320
Gilles Peskine30de2e82020-04-20 21:39:22 +02002321 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002322 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002323
2324 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2325 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002326}
2327
Gilles Peskine8386ea22020-04-30 09:07:29 +02002328component_test_full_no_deprecated_deprecated_warning () {
2329 # Test that there is nothing deprecated in "full_no_deprecated".
2330 # A deprecated feature would trigger a warning (made fatal) from
2331 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002332 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2333 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002334 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2335 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002336 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002337
Gilles Peskine30de2e82020-04-20 21:39:22 +02002338 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002339 make test
2340}
2341
Gilles Peskine8386ea22020-04-30 09:07:29 +02002342component_test_full_deprecated_warning () {
2343 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2344 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002345 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002346 scripts/config.py full
2347 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002348 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002349 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2350 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002351 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002352
Gilles Peskine8386ea22020-04-30 09:07:29 +02002353 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2354 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2355 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002356 # Expect warnings from '#warning' directives in check_config.h and
2357 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002358 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 +01002359
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002360 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2361 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002362
2363 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2364 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002365}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002366
Gilles Peskineec541fe2020-01-31 14:24:14 +01002367# Check that the specified libraries exist and are empty.
2368are_empty_libraries () {
2369 nm "$@" >/dev/null 2>/dev/null
2370 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2371}
2372
2373component_build_crypto_default () {
2374 msg "build: make, crypto only"
2375 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002376 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002377 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002378}
2379
2380component_build_crypto_full () {
2381 msg "build: make, crypto only, full config"
2382 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002383 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002384 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002385}
2386
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002387component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002388 msg "build: make, config for PSA crypto service"
2389 scripts/config.py crypto
2390 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2391 # Disable things that are not needed for just cryptography, to
2392 # reach a configuration that would be typical for a PSA cryptography
2393 # service providing all implemented PSA algorithms.
2394 # System stuff
2395 scripts/config.py unset MBEDTLS_ERROR_C
2396 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002397 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002398 # Crypto stuff with no PSA interface
2399 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002400 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002401 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002402 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002403 scripts/config.py unset MBEDTLS_NIST_KW_C
2404 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2405 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2406 scripts/config.py unset MBEDTLS_PKCS12_C
2407 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002408 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2409 # in PSA code to work with RSA keys. We don't require users to set those:
2410 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002411 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002412 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002413 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002414 make CFLAGS='-O1 -Werror' all test
2415 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2416}
2417
Gilles Peskineec541fe2020-01-31 14:24:14 +01002418component_build_crypto_baremetal () {
2419 msg "build: make, crypto only, baremetal config"
2420 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002421 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002422 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002423}
Daniel Axtens446af202020-09-02 21:30:13 +10002424support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002425 support_build_baremetal "$@"
2426}
2427
2428component_build_baremetal () {
2429 msg "build: make, baremetal config"
2430 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002431 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002432}
2433support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002434 # Older Glibc versions include time.h from other headers such as stdlib.h,
2435 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2436 # problem, Ubuntu 18.04 is ok.
2437 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2438}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002439
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002440# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002441component_test_depends_py_cipher_id () {
2442 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002443 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002444}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002445
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002446component_test_depends_py_cipher_chaining () {
2447 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002448 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002449}
2450
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002451component_test_depends_py_cipher_padding () {
2452 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002453 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002454}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002455
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002456component_test_depends_py_curves () {
2457 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002458 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002459}
2460
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002461component_test_depends_py_hashes () {
2462 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002463 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002464}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002465
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002466component_test_depends_py_kex () {
2467 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002468 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002469}
2470
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002471component_test_depends_py_pkalgs () {
2472 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002473 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002474}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002475
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002476# PSA equivalents of the depends.py tests
2477component_test_depends_py_cipher_id_psa () {
2478 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002479 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002480}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002481
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002482component_test_depends_py_cipher_chaining_psa () {
2483 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002484 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002485}
2486
2487component_test_depends_py_cipher_padding_psa () {
2488 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002489 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002490}
2491
2492component_test_depends_py_curves_psa () {
2493 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002494 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002495}
2496
2497component_test_depends_py_hashes_psa () {
2498 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002499 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002500}
2501
2502component_test_depends_py_kex_psa () {
2503 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002504 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002505}
2506
2507component_test_depends_py_pkalgs_psa () {
2508 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002509 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002510}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002511
Valerio Setti6bed64e2024-01-17 15:21:44 +01002512component_test_psa_crypto_config_ffdh_2048_only () {
2513 msg "build: full config - only DH 2048"
2514
2515 scripts/config.py full
2516
2517 # Disable all DH groups other than 2048.
2518 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2519 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2520 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2521 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2522
2523 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2524
2525 msg "test: full config - only DH 2048"
2526 make test
2527
2528 msg "ssl-opt: full config - only DH 2048"
2529 tests/ssl-opt.sh -f "ffdh"
2530}
2531
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002532component_build_no_pk_rsa_alt_support () {
2533 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2534
2535 scripts/config.py full
2536 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2537 scripts/config.py set MBEDTLS_RSA_C
2538 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2539
2540 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002541 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002542}
2543
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002544component_build_module_alt () {
2545 msg "build: MBEDTLS_XXX_ALT" # ~30s
2546 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002547
2548 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002549 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2550 scripts/config.py unset MBEDTLS_AESNI_C
2551 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002552 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002553 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2554 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002555 # You can only have one threading implementation: alt or pthread, not both.
2556 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002557 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2558 # directly and assumes the implementation works with partial groups.
2559 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002560 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2561 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2562 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002563 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2564 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2565 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002566
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002567 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2568 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2569 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002570 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002571
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002572 # We can only compile, not link, since we don't have any implementations
2573 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002574 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002575}
2576
2577component_build_dhm_alt () {
2578 msg "build: MBEDTLS_DHM_ALT" # ~30s
2579 scripts/config.py full
2580 scripts/config.py set MBEDTLS_DHM_ALT
2581 # debug.c currently references mbedtls_dhm_context fields directly.
2582 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002583 # We can only compile, not link, since we don't have any implementations
2584 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002585 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002586}
2587
Gilles Peskine64996c32024-01-23 20:25:47 +01002588component_test_no_psa_crypto_full_cmake_asan() {
2589 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2590 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002591 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002592 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002593 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002594 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002595 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002596 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002597 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002598 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002599 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002600 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002601 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002602 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002603
Gilles Peskine64996c32024-01-23 20:25:47 +01002604 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002605 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002606
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002607 # Note: ssl-opt.sh has some test cases that depend on
2608 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2609 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002610 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002611 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002612
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002613 msg "test: compat.sh default (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002614 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002615
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002616 msg "test: compat.sh NULL (full minus PSA crypto)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002617 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002618
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002619 msg "test: compat.sh ARIA + ChachaPoly (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002620 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002621}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002622
Ronald Cron403c15c2021-09-13 09:38:05 +02002623component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002624 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002625
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002626 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002627 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002628 $(helper_get_psa_key_type_list "ECC") \
2629 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002630
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002631 # Configure
2632 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002633
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002634 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002635 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002636
2637 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002638 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002639
2640 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002641 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2642 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2643
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002644 # Build
2645 # -----
2646
2647 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002648 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2649 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002650
2651 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2652
Valerio Setti3fe105b2023-10-30 11:08:12 +01002653 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002654
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002655 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002656 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002657
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002658 # Run the tests
2659 # -------------
2660
Ronald Cron403c15c2021-09-13 09:38:05 +02002661 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2662 make test
2663}
2664
Valerio Setti44b178c2023-03-22 14:02:57 +01002665component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002666 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002667
2668 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002669 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002670 $(helper_get_psa_key_type_list "ECC") \
2671 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002672
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002673 # Configure
2674 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002675
Ronald Cron46ac0652024-03-18 12:39:04 +01002676 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002677 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002678
Valerio Setti44b178c2023-03-22 14:02:57 +01002679 # Disable the module that's accelerated
2680 scripts/config.py unset MBEDTLS_ECDH_C
2681
2682 # Disable things that depend on it
2683 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2684 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2685 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2686 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2687 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2688
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002689 # Build
2690 # -----
2691
2692 helper_libtestdriver1_make_drivers "$loc_accel_list"
2693
Valerio Setti3fe105b2023-10-30 11:08:12 +01002694 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002695
Valerio Setti44b178c2023-03-22 14:02:57 +01002696 # Make sure this was not re-enabled by accident (additive config)
2697 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002698
2699 # Run the tests
2700 # -------------
2701
Valerio Setti44b178c2023-03-22 14:02:57 +01002702 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002703 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002704}
2705
Przemek Stekieldccb2022023-05-11 10:48:50 +02002706component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002707 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002708
2709 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002710 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002711 $(helper_get_psa_key_type_list "DH") \
2712 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002713
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002714 # Configure
2715 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002716
Przemek Stekiel565353e2023-07-05 11:07:07 +02002717 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002718 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002719
2720 # Disable the module that's accelerated
2721 scripts/config.py unset MBEDTLS_DHM_C
2722
2723 # Disable things that depend on it
2724 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2725 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2726
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002727 # Build
2728 # -----
2729
2730 helper_libtestdriver1_make_drivers "$loc_accel_list"
2731
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002732 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002733
2734 # Make sure this was not re-enabled by accident (additive config)
2735 not grep mbedtls_dhm_ library/dhm.o
2736
2737 # Run the tests
2738 # -------------
2739
Gilles Peskine14302ed2023-07-19 19:30:04 +02002740 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002741 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002742
Gilles Peskine14302ed2023-07-19 19:30:04 +02002743 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002744 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002745}
2746
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002747component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002748 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002749
2750 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002751 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002752
2753 # Disable things that are not supported
2754 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2755 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002756 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002757
Gilles Peskine14302ed2023-07-19 19:30:04 +02002758 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002759 make test
2760
Gilles Peskine14302ed2023-07-19 19:30:04 +02002761 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002762 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002763}
2764
Valerio Setti44b178c2023-03-22 14:02:57 +01002765component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002766 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002767
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002768 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002769 $(helper_get_psa_key_type_list "ECC") \
2770 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002771
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002772 # Configure
2773 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002774
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002775 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002776
2777 # Make built-in fallback not available
2778 scripts/config.py unset MBEDTLS_ECJPAKE_C
2779 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2780
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002781 # Build
2782 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002783
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002784 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002785
Valerio Setti3fe105b2023-10-30 11:08:12 +01002786 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002787
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002788 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002789 not grep mbedtls_ecjpake_init library/ecjpake.o
2790
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002791 # Run the tests
2792 # -------------
2793
Gilles Peskine14302ed2023-07-19 19:30:04 +02002794 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002795 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002796}
2797
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002798component_test_psa_crypto_config_accel_ecc_some_key_types () {
2799 msg "build: full with accelerated EC algs and some key types"
2800
2801 # Algorithms and key types to accelerate
2802 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2803 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2804 ALG_ECDH \
2805 ALG_JPAKE \
2806 KEY_TYPE_ECC_PUBLIC_KEY \
2807 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2808 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002809 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2810 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002811
2812 # Configure
2813 # ---------
2814
2815 # start with config full for maximum coverage (also enables USE_PSA)
2816 helper_libtestdriver1_adjust_config "full"
2817
2818 # Disable modules that are accelerated - some will be re-enabled
2819 scripts/config.py unset MBEDTLS_ECDSA_C
2820 scripts/config.py unset MBEDTLS_ECDH_C
2821 scripts/config.py unset MBEDTLS_ECJPAKE_C
2822 scripts/config.py unset MBEDTLS_ECP_C
2823
2824 # Disable all curves - those that aren't accelerated should be re-enabled
2825 helper_disable_builtin_curves
2826
2827 # Restartable feature is not yet supported by PSA. Once it will in
2828 # the future, the following line could be removed (see issues
2829 # 6061, 6332 and following ones)
2830 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2831
2832 # this is not supported by the driver API yet
2833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2834
2835 # Build
2836 # -----
2837
2838 # These hashes are needed for some ECDSA signature tests.
2839 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2840 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2841 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2842
Valerio Setti3fe105b2023-10-30 11:08:12 +01002843 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002844
2845 # ECP should be re-enabled but not the others
2846 not grep mbedtls_ecdh_ library/ecdh.o
2847 not grep mbedtls_ecdsa library/ecdsa.o
2848 not grep mbedtls_ecjpake library/ecjpake.o
2849 grep mbedtls_ecp library/ecp.o
2850
2851 # Run the tests
2852 # -------------
2853
2854 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002855 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002856}
2857
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002858# Run tests with only (non-)Weierstrass accelerated
2859# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002860# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2861# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002862common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002863 weierstrass=$1
2864 if [ $weierstrass -eq 1 ]; then
2865 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002866 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002867 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002868 fi
2869
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002870 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002871
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002872 # Note: Curves are handled in a special way by the libtestdriver machinery,
2873 # so we only want to include them in the accel list when building the main
2874 # libraries, hence the use of a separate variable.
2875 # Note: the following loop is a modified version of
2876 # helper_get_psa_curve_list that only keeps Weierstrass families.
2877 loc_weierstrass_list=""
2878 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002879 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2880 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002881 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002882 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002883 ;;
2884 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002885 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002886 ;;
2887 esac
2888 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002889 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002890 loc_curve_list=$loc_weierstrass_list
2891 else
2892 loc_curve_list=$loc_non_weierstrass_list
2893 fi
2894
Valerio Setti3fe105b2023-10-30 11:08:12 +01002895 # Algorithms and key types to accelerate
2896 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2897 ALG_ECDH \
2898 ALG_JPAKE \
2899 $(helper_get_psa_key_type_list "ECC") \
2900 $loc_curve_list"
2901
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002902 # Configure
2903 # ---------
2904
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002905 # Start with config crypto_full and remove PK_C:
2906 # that's what's supported now, see docs/driver-only-builds.md.
2907 helper_libtestdriver1_adjust_config "crypto_full"
2908 scripts/config.py unset MBEDTLS_PK_C
2909 scripts/config.py unset MBEDTLS_PK_PARSE_C
2910 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002911
2912 # Disable modules that are accelerated - some will be re-enabled
2913 scripts/config.py unset MBEDTLS_ECDSA_C
2914 scripts/config.py unset MBEDTLS_ECDH_C
2915 scripts/config.py unset MBEDTLS_ECJPAKE_C
2916 scripts/config.py unset MBEDTLS_ECP_C
2917
2918 # Disable all curves - those that aren't accelerated should be re-enabled
2919 helper_disable_builtin_curves
2920
2921 # Restartable feature is not yet supported by PSA. Once it will in
2922 # the future, the following line could be removed (see issues
2923 # 6061, 6332 and following ones)
2924 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2925
2926 # this is not supported by the driver API yet
2927 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2928
2929 # Build
2930 # -----
2931
2932 # These hashes are needed for some ECDSA signature tests.
2933 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2934 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2935 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2936
Valerio Settiac7a8092023-10-31 12:23:44 +01002937 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002938
2939 # We expect ECDH to be re-enabled for the missing curves
2940 grep mbedtls_ecdh_ library/ecdh.o
2941 # We expect ECP to be re-enabled, however the parts specific to the
2942 # families of curves that are accelerated should be ommited.
2943 # - functions with mxz in the name are specific to Montgomery curves
2944 # - ecp_muladd is specific to Weierstrass curves
2945 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002946 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002947 not grep mbedtls_ecp_muladd library/ecp.o
2948 grep mxz library/ecp.o
2949 else
2950 grep mbedtls_ecp_muladd library/ecp.o
2951 not grep mxz library/ecp.o
2952 fi
2953 # We expect ECDSA and ECJPAKE to be re-enabled only when
2954 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002955 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002956 not grep mbedtls_ecdsa library/ecdsa.o
2957 not grep mbedtls_ecjpake library/ecjpake.o
2958 else
2959 grep mbedtls_ecdsa library/ecdsa.o
2960 grep mbedtls_ecjpake library/ecjpake.o
2961 fi
2962
2963 # Run the tests
2964 # -------------
2965
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002966 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2967 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002968}
2969
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002970component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002971 common_test_psa_crypto_config_accel_ecc_some_curves 1
2972}
2973
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002974component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002975 common_test_psa_crypto_config_accel_ecc_some_curves 0
2976}
2977
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002978# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2979# ECDH, ECDSA) with and without drivers.
2980# The input parameter is a boolean value which indicates:
2981# - 0 keep built-in EC algs,
2982# - 1 exclude built-in EC algs (driver only).
2983#
2984# This is used by the two following components to ensure they always use the
2985# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002986# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2987# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002988# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002989config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002990 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002991 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002992 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002993 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002994 # Disable modules that are accelerated
2995 scripts/config.py unset MBEDTLS_ECDSA_C
2996 scripts/config.py unset MBEDTLS_ECDH_C
2997 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002998 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002999 fi
3000
3001 # Restartable feature is not yet supported by PSA. Once it will in
3002 # the future, the following line could be removed (see issues
3003 # 6061, 6332 and following ones)
3004 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003005}
3006
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003007# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3008component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003009 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003010
3011 # Algorithms and key types to accelerate
3012 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3013 ALG_ECDH \
3014 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003015 $(helper_get_psa_key_type_list "ECC") \
3016 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003017
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003018 # Configure
3019 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003020
3021 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003022 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003023
Valerio Setti0a342c92023-09-01 09:12:31 +02003024 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003025 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3026 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003027
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003028 # Build
3029 # -----
3030
3031 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003032 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3033 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003034 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3035
Valerio Setti3fe105b2023-10-30 11:08:12 +01003036 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003037
3038 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3039 not grep mbedtls_ecdsa_ library/ecdsa.o
3040 not grep mbedtls_ecdh_ library/ecdh.o
3041 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003042 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003043
3044 # Run the tests
3045 # -------------
3046
Gilles Peskine14302ed2023-07-19 19:30:04 +02003047 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003048 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003049
Gilles Peskine14302ed2023-07-19 19:30:04 +02003050 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003051 tests/ssl-opt.sh
3052}
3053
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003054# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3055component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003056 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003057
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003058 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003059
Gilles Peskine21570cf2023-12-22 11:49:50 +01003060 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003061
Gilles Peskine14302ed2023-07-19 19:30:04 +02003062 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003063 make test
3064
Gilles Peskine14302ed2023-07-19 19:30:04 +02003065 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003066 tests/ssl-opt.sh
3067}
3068
Valerio Settie618cb02023-04-12 14:59:16 +02003069# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003070# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3071# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003072# to ensure that both tests use the same underlying configuration when testing
3073# driver's coverage with analyze_outcomes.py.
3074#
3075# This functions accepts 1 boolean parameter as follows:
3076# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3077# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3078# - 0: include built-in implementation of EC algorithms.
3079#
3080# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3081# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003082config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003083 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003084 # start with full config for maximum coverage (also enables USE_PSA)
3085 helper_libtestdriver1_adjust_config "full"
3086
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003087 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003088 # Disable modules that are accelerated
3089 scripts/config.py unset MBEDTLS_ECDSA_C
3090 scripts/config.py unset MBEDTLS_ECDH_C
3091 scripts/config.py unset MBEDTLS_ECJPAKE_C
3092 # Disable ECP module (entirely)
3093 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003094 fi
3095
Valerio Settiaecd32c2023-06-14 10:42:31 +02003096 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3097 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003098 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003099 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003100
Valerio Settie618cb02023-04-12 14:59:16 +02003101 # Restartable feature is not yet supported by PSA. Once it will in
3102 # the future, the following line could be removed (see issues
3103 # 6061, 6332 and following ones)
3104 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003105}
3106
3107# Build and test a configuration where driver accelerates all EC algs while
3108# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3109# side.
3110#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003111# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3112component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003113 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003114
3115 # Algorithms and key types to accelerate
3116 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3117 ALG_ECDH \
3118 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003119 $(helper_get_psa_key_type_list "ECC") \
3120 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003121
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003122 # Configure
3123 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003124
Valerio Settie618cb02023-04-12 14:59:16 +02003125 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003126 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003127 # Disable all the builtin curves. All the required algs are accelerated.
3128 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003129
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003130 # Build
3131 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003132
3133 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003134 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3135 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3136 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003137
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003138 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003139
Valerio Setti3fe105b2023-10-30 11:08:12 +01003140 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003141
3142 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3143 not grep mbedtls_ecdsa_ library/ecdsa.o
3144 not grep mbedtls_ecdh_ library/ecdh.o
3145 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003146 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003147 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003148
3149 # Run the tests
3150 # -------------
3151
Gilles Peskine14302ed2023-07-19 19:30:04 +02003152 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003153 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003154
Gilles Peskine14302ed2023-07-19 19:30:04 +02003155 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003156 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003157}
3158
3159# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003160# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003161# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003162component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003163 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003164
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003165 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003166
Gilles Peskine21570cf2023-12-22 11:49:50 +01003167 make
Valerio Settie618cb02023-04-12 14:59:16 +02003168
Gilles Peskine14302ed2023-07-19 19:30:04 +02003169 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003170 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003171
Gilles Peskine14302ed2023-07-19 19:30:04 +02003172 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003173 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003174}
3175
Valerio Setti4e2f2442023-08-15 10:10:26 +02003176# This is a common configuration helper used directly from:
3177# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3178# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3179# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003180# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003181# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003182# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003183# - this is the reference component of the above
3184# - it still disables RSA and FFDH, but it uses builtin EC algs
3185# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3186# - accelerate all EC and FFDH algs, disable only RSA
3187# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3188# - this is the reference component of the above
3189# - it still disables RSA, but it uses builtin EC and FFDH algs
3190#
3191# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003192# $1: a boolean value which states if we are testing an accelerated scenario
3193# or not.
3194# $2: a string value which states which components are tested. Allowed values
3195# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003196config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003197 driver_only="$1"
3198 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003199 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003200 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003201
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003202 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003203 # Disable modules that are accelerated
3204 scripts/config.py unset MBEDTLS_ECDSA_C
3205 scripts/config.py unset MBEDTLS_ECDH_C
3206 scripts/config.py unset MBEDTLS_ECJPAKE_C
3207 # Disable ECP module (entirely)
3208 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003209 # Also disable bignum
3210 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003211 fi
3212
3213 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3214 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3215 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3216 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3217
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003218 # RSA support is intentionally disabled on this test because RSA_C depends
3219 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003220 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3221 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 +02003222 scripts/config.py unset MBEDTLS_RSA_C
3223 scripts/config.py unset MBEDTLS_PKCS1_V15
3224 scripts/config.py unset MBEDTLS_PKCS1_V21
3225 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3226 # Also disable key exchanges that depend on RSA
3227 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3228 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3229 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3230 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3231 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3232
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003233 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003234 # When testing ECC only, we disable FFDH support, both from builtin and
3235 # PSA sides, and also disable the key exchanges that depend on DHM.
3236 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3237 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 +01003238 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003239 scripts/config.py unset MBEDTLS_DHM_C
3240 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3241 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3242 else
3243 # When testing ECC and DH instead, we disable DHM and depending key
3244 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003245 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003246 scripts/config.py unset MBEDTLS_DHM_C
3247 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3248 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3249 fi
3250 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003251
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003252 # Restartable feature is not yet supported by PSA. Once it will in
3253 # the future, the following line could be removed (see issues
3254 # 6061, 6332 and following ones)
3255 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3256}
3257
Valerio Setti4e2f2442023-08-15 10:10:26 +02003258# Common helper used by:
3259# - component_test_psa_crypto_config_accel_ecc_no_bignum
3260# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003261#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003262# The goal is to build and test accelerating either:
3263# - ECC only or
3264# - both ECC and FFDH
3265#
3266# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003267# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3268# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003269common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003270 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003271
Valerio Setti5dfaca42023-09-05 08:48:51 +02003272 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003273 if [ "$test_target" = "ECC_DH" ]; then
3274 accel_text="ECC/FFDH"
3275 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003276 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003277 accel_text="ECC"
3278 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003279 fi
3280
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003281 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003282
3283 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003284 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3285 ALG_ECDH \
3286 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003287 $(helper_get_psa_key_type_list "ECC") \
3288 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003289 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003290 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003291 loc_accel_list="$loc_accel_list \
3292 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003293 $(helper_get_psa_key_type_list "DH") \
3294 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003295 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003296
3297 # Configure
3298 # ---------
3299
3300 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003301 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003302 # Disable all the builtin curves. All the required algs are accelerated.
3303 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003304
3305 # Build
3306 # -----
3307
3308 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003309 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3310 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3311 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003312
3313 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3314
Valerio Setti3fe105b2023-10-30 11:08:12 +01003315 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003316
3317 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3318 not grep mbedtls_ecdsa_ library/ecdsa.o
3319 not grep mbedtls_ecdh_ library/ecdh.o
3320 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003321 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003322 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003323 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003324 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003325 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003326
3327 # Run the tests
3328 # -------------
3329
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003330 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003331
Gilles Peskine21570cf2023-12-22 11:49:50 +01003332 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003333
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003334 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003335 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003336}
3337
Valerio Setti4e2f2442023-08-15 10:10:26 +02003338# Common helper used by:
3339# - component_test_psa_crypto_config_reference_ecc_no_bignum
3340# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3341#
3342# The goal is to build and test a reference scenario (i.e. with builtin
3343# components) compared to the ones used in
3344# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3345#
3346# It is meant to be used in conjunction with
3347# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3348# coverage analysis in "analyze_outcomes.py" script.
3349common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003350 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003351
Valerio Setti5dfaca42023-09-05 08:48:51 +02003352 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003353 if [ "$test_target" = "ECC_DH" ]; then
3354 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003355 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003356 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003357 fi
3358
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003359 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003360
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003361 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003362
Gilles Peskine21570cf2023-12-22 11:49:50 +01003363 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003364
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003365 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003366 make test
3367
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003368 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003369 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003370}
3371
Valerio Setti4e2f2442023-08-15 10:10:26 +02003372component_test_psa_crypto_config_accel_ecc_no_bignum () {
3373 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3374}
3375
3376component_test_psa_crypto_config_reference_ecc_no_bignum () {
3377 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3378}
3379
3380component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3381 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3382}
3383
3384component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3385 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3386}
3387
Valerio Settiac6d35f2023-08-04 12:49:11 +02003388# Helper for setting common configurations between:
3389# - component_test_tfm_config_p256m_driver_accel_ec()
3390# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003391common_tfm_config () {
3392 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003393 cp configs/config-tfm.h "$CONFIG_H"
3394 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3395 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003396
Yanray Wang73bb2312023-09-25 11:21:15 +08003397 # Other config adjustment to make the tests pass.
3398 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003399 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003400 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3401 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003402
Yanray Wang73bb2312023-09-25 11:21:15 +08003403 # Config adjustment for better test coverage in our environment.
3404 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003405 #
3406 # Enable filesystem I/O for the benefit of PK parse/write tests.
3407 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3408}
3409
Valerio Settiac6d35f2023-08-04 12:49:11 +02003410# Keep this in sync with component_test_tfm_config() as they are both meant
3411# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003412component_test_tfm_config_p256m_driver_accel_ec () {
3413 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3414
3415 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003416
Dave Rodgman897bb772023-11-15 16:34:20 +00003417 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003418 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003419
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003420 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3421 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003422 not grep mbedtls_ecdh_ library/ecdh.o
3423 not grep mbedtls_ecjpake_ library/ecjpake.o
3424 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3425 not grep mbedtls_ecp_ library/ecp.o
3426 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003427 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003428 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003429 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003430 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003431
Valerio Setti5e18b902023-12-04 12:07:30 +01003432 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3433 # files, so we want to ensure that it has not be re-enabled accidentally.
3434 not grep mbedtls_cipher library/cipher.o
3435
Valerio Settib7e95442023-03-21 11:52:33 +01003436 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003437 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003438 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003439}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003440
Valerio Settiac6d35f2023-08-04 12:49:11 +02003441# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3442# they are both meant to be used in analyze_outcomes.py for driver's coverage
3443# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003444component_test_tfm_config() {
3445 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003446
Dave Rodgman897bb772023-11-15 16:34:20 +00003447 # Disable P256M driver, which is on by default, so that analyze_outcomes
3448 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3449 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3450
Valerio Setti52ba0e32023-08-04 12:43:03 +02003451 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003452 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003453
Dave Rodgman897bb772023-11-15 16:34:20 +00003454 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003455 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003456
Valerio Setti5e18b902023-12-04 12:07:30 +01003457 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3458 # files, so we want to ensure that it has not be re-enabled accidentally.
3459 not grep mbedtls_cipher library/cipher.o
3460
Valerio Setti52ba0e32023-08-04 12:43:03 +02003461 msg "test: TF-M config"
3462 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003463}
3464
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003465# Common helper for component_full_without_ecdhe_ecdsa() and
3466# component_full_without_ecdhe_ecdsa_and_tls13() which:
3467# - starts from the "full" configuration minus the list of symbols passed in
3468# as 1st parameter
3469# - build
3470# - test only TLS (i.e. test_suite_tls and ssl-opt)
3471build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003472 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003473
3474 msg "build: full minus something, test TLS"
3475
3476 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003477 for sym in $symbols_to_disable; do
3478 echo "Disabling $sym"
3479 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003480 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003481
Gilles Peskine21570cf2023-12-22 11:49:50 +01003482 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003483
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003484 msg "test: full minus something, test TLS"
3485 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003486
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003487 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003488 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003489}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003490
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003491component_full_without_ecdhe_ecdsa () {
3492 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003493}
3494
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003495component_full_without_ecdhe_ecdsa_and_tls13 () {
3496 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3497 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003498}
3499
Valerio Setti249b18a2023-06-20 12:08:30 +02003500# This is an helper used by:
3501# - component_test_psa_ecc_key_pair_no_derive
3502# - component_test_psa_ecc_key_pair_no_generate
3503# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3504# enabled, but one. Input arguments are as follows:
3505# - $1 is the key type under test, i.e. ECC/RSA/DH
3506# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003507build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003508 key_type=$1
3509 unset_option=$2
3510 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003511
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003512 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003513 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003514 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3515 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3516
3517 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3518 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003519 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003520
Gilles Peskine21570cf2023-12-22 11:49:50 +01003521 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003522
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003523 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003524 make test
3525}
3526
3527component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003528 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003529}
3530
3531component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003532 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003533}
3534
Pengyu Lve705f572023-12-06 16:38:15 +08003535config_psa_crypto_accel_rsa () {
3536 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003537
Pengyu Lve705f572023-12-06 16:38:15 +08003538 # Start from crypto_full config (no X.509, no TLS)
3539 helper_libtestdriver1_adjust_config "crypto_full"
3540
3541 if [ "$driver_only" -eq 1 ]; then
3542 # Remove RSA support and its dependencies
3543 scripts/config.py unset MBEDTLS_RSA_C
3544 scripts/config.py unset MBEDTLS_PKCS1_V15
3545 scripts/config.py unset MBEDTLS_PKCS1_V21
3546
3547 # We need PEM parsing in the test library as well to support the import
3548 # of PEM encoded RSA keys.
3549 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3550 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3551 fi
3552}
3553
3554component_test_psa_crypto_config_accel_rsa_crypto () {
3555 msg "build: crypto_full with accelerated RSA"
3556
3557 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3558 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3559 KEY_TYPE_RSA_PUBLIC_KEY \
3560 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3561 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3562 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3563 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003564
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003565 # Configure
3566 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003567
Pengyu Lve705f572023-12-06 16:38:15 +08003568 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003569
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003570 # Build
3571 # -----
3572
Pengyu Lve705f572023-12-06 16:38:15 +08003573 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003574 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 +08003575 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003576 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003577
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003578 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003579
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003580 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003581 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003582
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003583 # Run the tests
3584 # -------------
3585
Pengyu Lve705f572023-12-06 16:38:15 +08003586 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003587 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003588}
3589
3590component_test_psa_crypto_config_reference_rsa_crypto () {
3591 msg "build: crypto_full with non-accelerated RSA"
3592
3593 # Configure
3594 # ---------
3595 config_psa_crypto_accel_rsa 0
3596
3597 # Build
3598 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003599 make
Pengyu Lve705f572023-12-06 16:38:15 +08003600
3601 # Run the tests
3602 # -------------
3603 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003604 make test
3605}
3606
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003607# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003608# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003609component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003610 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003611
Valerio Setti4590bc22023-06-13 15:39:23 +02003612 # Create a temporary output file unless there is already one set
3613 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3614 REMOVE_OUTCOME_ON_EXIT="no"
3615 else
3616 REMOVE_OUTCOME_ON_EXIT="yes"
3617 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3618 export MBEDTLS_TEST_OUTCOME_FILE
3619 fi
3620
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003621 # Start from crypto configuration
3622 scripts/config.py crypto
3623
3624 # Remove RSA support and its dependencies
3625 scripts/config.py unset MBEDTLS_PKCS1_V15
3626 scripts/config.py unset MBEDTLS_PKCS1_V21
3627 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3628 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3629 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3630 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3631 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3632 scripts/config.py unset MBEDTLS_RSA_C
3633 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3634
3635 # Enable PSA support
3636 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3637
Valerio Setti01cc88a2023-06-15 11:53:08 +02003638 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003639 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003640 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3641 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3642 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003643
3644 make
3645
Valerio Setti01cc88a2023-06-15 11:53:08 +02003646 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003647 make test
3648
3649 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3650 # performing RSA signature.
3651 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3652 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3653
3654 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3655 rm $MBEDTLS_TEST_OUTCOME_FILE
3656 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003657}
3658
Ronald Cronb2312452021-05-08 14:32:59 +02003659component_test_psa_crypto_config_accel_hash () {
3660 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3661
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003662 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3663 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3664 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003665
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003666 # Configure
3667 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003668
Ronald Cron46ac0652024-03-18 12:39:04 +01003669 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003670 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003671
3672 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003673 scripts/config.py unset MBEDTLS_MD5_C
3674 scripts/config.py unset MBEDTLS_RIPEMD160_C
3675 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003676 scripts/config.py unset MBEDTLS_SHA224_C
3677 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003678 scripts/config.py unset MBEDTLS_SHA384_C
3679 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003680 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003681
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003682 # Build
3683 # -----
3684
3685 helper_libtestdriver1_make_drivers "$loc_accel_list"
3686
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003687 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003688
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003689 # There's a risk of something getting re-enabled via config_psa.h;
3690 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3691 not grep mbedtls_md5 library/md5.o
3692 not grep mbedtls_sha1 library/sha1.o
3693 not grep mbedtls_sha256 library/sha256.o
3694 not grep mbedtls_sha512 library/sha512.o
3695 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003696
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003697 # Run the tests
3698 # -------------
3699
Ronald Cronb2312452021-05-08 14:32:59 +02003700 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3701 make test
3702}
3703
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003704component_test_psa_crypto_config_accel_hash_keep_builtins () {
3705 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3706 # This component ensures that all the test cases for
3707 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3708
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003709 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3710 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3711 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003712
Ronald Cron46ac0652024-03-18 12:39:04 +01003713 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003714 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003715
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003716 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003717
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003718 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003719
3720 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3721 make test
3722}
3723
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003724# Auxiliary function to build config for hashes with and without drivers
3725config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003726 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003727 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003728 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003729 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003730 # disable the built-in implementation of hashes
3731 scripts/config.py unset MBEDTLS_MD5_C
3732 scripts/config.py unset MBEDTLS_RIPEMD160_C
3733 scripts/config.py unset MBEDTLS_SHA1_C
3734 scripts/config.py unset MBEDTLS_SHA224_C
3735 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003736 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003737 scripts/config.py unset MBEDTLS_SHA384_C
3738 scripts/config.py unset MBEDTLS_SHA512_C
3739 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003740 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003741 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003742}
3743
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003744# Note that component_test_psa_crypto_config_reference_hash_use_psa
3745# is related to this component and both components need to be kept in sync.
3746# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003747component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003748 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003749
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003750 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3751 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3752 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003753
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003754 # Configure
3755 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003756
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003757 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003758
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003759 # Build
3760 # -----
3761
3762 helper_libtestdriver1_make_drivers "$loc_accel_list"
3763
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003764 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003765
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003766 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003767 # 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 +02003768 not grep mbedtls_md5 library/md5.o
3769 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003770 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003771 not grep mbedtls_sha512 library/sha512.o
3772 not grep mbedtls_ripemd160 library/ripemd160.o
3773
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003774 # Run the tests
3775 # -------------
3776
Gilles Peskine14302ed2023-07-19 19:30:04 +02003777 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003778 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003779
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003780 # This is mostly useful so that we can later compare outcome files with
3781 # the reference config in analyze_outcomes.py, to check that the
3782 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003783 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003784 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003785
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003786 # This is to make sure all ciphersuites are exercised, but we don't need
3787 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003788 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003789 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003790}
3791
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003792# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3793# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3794# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3795# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003796component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003797 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003798
3799 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003800
Gilles Peskine21570cf2023-12-22 11:49:50 +01003801 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003802
Gilles Peskine14302ed2023-07-19 19:30:04 +02003803 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003804 make test
3805
Gilles Peskine14302ed2023-07-19 19:30:04 +02003806 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003807 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003808}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003809
Valerio Setti8eb310c2024-01-22 16:22:57 +01003810# Auxiliary function to build config for hashes with and without drivers
3811config_psa_crypto_hmac_use_psa () {
3812 driver_only="$1"
3813 # start with config full for maximum coverage (also enables USE_PSA)
3814 helper_libtestdriver1_adjust_config "full"
3815
Valerio Setticd89b0b2024-01-24 14:24:55 +01003816 if [ "$driver_only" -eq 1 ]; then
3817 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3818 # is still enabled though (for ENTROPY_C among others).
3819 scripts/config.py unset MBEDTLS_MD_C
3820 # Disable also the builtin hashes since they are supported by the driver
3821 # and MD module is able to perform PSA dispathing.
3822 scripts/config.py unset-all MBEDTLS_SHA
3823 scripts/config.py unset MBEDTLS_MD5_C
3824 scripts/config.py unset MBEDTLS_RIPEMD160_C
3825 fi
3826
Valerio Setti8eb310c2024-01-22 16:22:57 +01003827 # Direct dependencies of MD_C. We disable them also in the reference
3828 # component to work with the same set of features.
3829 scripts/config.py unset MBEDTLS_PKCS7_C
3830 scripts/config.py unset MBEDTLS_PKCS5_C
3831 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3832 scripts/config.py unset MBEDTLS_HKDF_C
3833 # Dependencies of HMAC_DRBG
3834 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3835 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3836}
3837
3838component_test_psa_crypto_config_accel_hmac() {
3839 msg "test: full with accelerated hmac"
3840
3841 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3842 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3843 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3844 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3845
3846 # Configure
3847 # ---------
3848
3849 config_psa_crypto_hmac_use_psa 1
3850
Valerio Setti8eb310c2024-01-22 16:22:57 +01003851 # Build
3852 # -----
3853
3854 helper_libtestdriver1_make_drivers "$loc_accel_list"
3855
3856 helper_libtestdriver1_make_main "$loc_accel_list"
3857
3858 # Ensure that built-in support for HMAC is disabled.
3859 not grep mbedtls_md_hmac library/md.o
3860
3861 # Run the tests
3862 # -------------
3863
3864 msg "test: full with accelerated hmac"
3865 make test
3866}
3867
3868component_test_psa_crypto_config_reference_hmac() {
3869 msg "test: full without accelerated hmac"
3870
3871 config_psa_crypto_hmac_use_psa 0
3872
3873 make
3874
3875 msg "test: full without accelerated hmac"
3876 make test
3877}
3878
Valerio Setti9da01a72023-12-18 17:38:18 +01003879component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003880 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003881
Valerio Setti9da01a72023-12-18 17:38:18 +01003882 # Albeit this components aims at accelerating DES which should only support
3883 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3884 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003885 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3886 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3887 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003888
Valerio Setti9da01a72023-12-18 17:38:18 +01003889 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3890 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3891 # of this component. This limitation will be addressed by #8598.
3892
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003893 # Configure
3894 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003895
Valerio Setti9a427302023-10-17 11:40:42 +02003896 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003897 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003898
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003899 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003900 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3901 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3902 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3903 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3904 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3905 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3906 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003907 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003908
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003909 # Build
3910 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003911
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003912 helper_libtestdriver1_make_drivers "$loc_accel_list"
3913
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003914 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003915
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003916 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003917 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003918
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003919 # Run the tests
3920 # -------------
3921
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003922 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003923 make test
3924}
3925
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003926component_test_psa_crypto_config_accel_aead () {
3927 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3928
Valerio Setti3f02bb72023-10-02 15:57:33 +02003929 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3930 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003931
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003932 # Configure
3933 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003934
Valerio Setti3f02bb72023-10-02 15:57:33 +02003935 # Start from full config
3936 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003937
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003938 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003939 scripts/config.py unset MBEDTLS_GCM_C
3940 scripts/config.py unset MBEDTLS_CCM_C
3941 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003942
Valerio Settia50b89e2023-11-08 15:58:47 +01003943 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3944 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003945
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003946 # Build
3947 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003948
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003949 helper_libtestdriver1_make_drivers "$loc_accel_list"
3950
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003951 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003952
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003953 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +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
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003958 # Run the tests
3959 # -------------
3960
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003961 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3962 make test
3963}
3964
Valerio Settib680fc42023-10-13 09:29:37 +02003965# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003966# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3967# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3968common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003969 # Start from the full config
3970 helper_libtestdriver1_adjust_config "full"
3971
Valerio Settib680fc42023-10-13 09:29:37 +02003972 scripts/config.py unset MBEDTLS_NIST_KW_C
3973}
3974
Valerio Settib6b301f2023-10-04 12:05:05 +02003975# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003976# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3977# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003978# are meant to be used together in analyze_outcomes.py script in order to test
3979# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003980component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3981 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003982
Valerio Settiad8b7f02023-10-25 12:39:50 +02003983 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 +01003984 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003985 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003986 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3987
3988 # Configure
3989 # ---------
3990
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003991 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003992
3993 # Disable the things that are being accelerated
3994 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3995 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3996 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3997 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3998 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3999 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4000 scripts/config.py unset MBEDTLS_GCM_C
4001 scripts/config.py unset MBEDTLS_CCM_C
4002 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004003 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004004 scripts/config.py unset MBEDTLS_DES_C
4005 scripts/config.py unset MBEDTLS_AES_C
4006 scripts/config.py unset MBEDTLS_ARIA_C
4007 scripts/config.py unset MBEDTLS_CHACHA20_C
4008 scripts/config.py unset MBEDTLS_CAMELLIA_C
4009
Valerio Settiec9b2582023-11-08 16:50:54 +01004010 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4011 # does not depend on it.
4012 scripts/config.py unset MBEDTLS_CIPHER_C
4013
Valerio Settib6b301f2023-10-04 12:05:05 +02004014 # Build
4015 # -----
4016
4017 helper_libtestdriver1_make_drivers "$loc_accel_list"
4018
4019 helper_libtestdriver1_make_main "$loc_accel_list"
4020
4021 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004022 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004023 not grep mbedtls_des library/des.o
4024 not grep mbedtls_aes library/aes.o
4025 not grep mbedtls_aria library/aria.o
4026 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004027 not grep mbedtls_ccm library/ccm.o
4028 not grep mbedtls_gcm library/gcm.o
4029 not grep mbedtls_chachapoly library/chachapoly.o
4030 not grep mbedtls_cmac library/cmac.o
4031
4032 # Run the tests
4033 # -------------
4034
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004035 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004036 make test
Valerio Settif9414552023-11-09 10:43:20 +01004037
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004038 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004039 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004040
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004041 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004042 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004043}
4044
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004045component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4046 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4047 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004048
Gilles Peskine21570cf2023-12-22 11:49:50 +01004049 make
Valerio Settif9414552023-11-09 10:43:20 +01004050
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004051 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004052 make test
Valerio Settif9414552023-11-09 10:43:20 +01004053
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004054 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004055 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004056
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004057 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004058 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004059}
4060
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004061common_block_cipher_dispatch() {
4062 TEST_WITH_DRIVER="$1"
4063
4064 # Start from the full config
4065 helper_libtestdriver1_adjust_config "full"
4066
4067 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4068 # Disable key types that are accelerated (there is no legacy equivalent
4069 # symbol for ECB)
4070 scripts/config.py unset MBEDTLS_AES_C
4071 scripts/config.py unset MBEDTLS_ARIA_C
4072 scripts/config.py unset MBEDTLS_CAMELLIA_C
4073 fi
4074
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004075 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004076 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004077 # Keep this also in the reference component in order to skip the same tests
4078 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004079 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4080 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4081 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4082 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4083 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4084 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4085 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004086
4087 # Disable direct dependency on AES_C
4088 scripts/config.py unset MBEDTLS_NIST_KW_C
4089
4090 # Prevent the cipher module from using deprecated PSA path. The reason is
4091 # that otherwise there will be tests relying on "aes_info" (defined in
4092 # "cipher_wrap.c") whose functions are not available when AES_C is
4093 # not defined. ARIA and Camellia are not a problem in this case because
4094 # the PSA path is not tested for these key types.
4095 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4096}
4097
Valerio Settif8e6cba2023-12-12 11:53:39 +01004098component_test_full_block_cipher_psa_dispatch () {
4099 msg "build: full + PSA dispatch in block_cipher"
4100
4101 loc_accel_list="ALG_ECB_NO_PADDING \
4102 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4103
4104 # Configure
4105 # ---------
4106
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004107 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004108
Valerio Settif8e6cba2023-12-12 11:53:39 +01004109 # Build
4110 # -----
4111
4112 helper_libtestdriver1_make_drivers "$loc_accel_list"
4113
4114 helper_libtestdriver1_make_main "$loc_accel_list"
4115
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004116 # Make sure disabled components were not re-enabled by accident (additive
4117 # config)
4118 not grep mbedtls_aes_ library/aes.o
4119 not grep mbedtls_aria_ library/aria.o
4120 not grep mbedtls_camellia_ library/camellia.o
4121
Valerio Settif8e6cba2023-12-12 11:53:39 +01004122 # Run the tests
4123 # -------------
4124
4125 msg "test: full + PSA dispatch in block_cipher"
4126 make test
4127}
4128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004129# This is the reference component of component_test_full_block_cipher_psa_dispatch
4130component_test_full_block_cipher_legacy_dispatch () {
4131 msg "build: full + legacy dispatch in block_cipher"
4132
4133 common_block_cipher_dispatch 0
4134
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004135 make
4136
4137 msg "test: full + legacy dispatch in block_cipher"
4138 make test
4139}
4140
Gilles Peskine36dea152023-07-20 22:19:45 +02004141component_test_aead_chachapoly_disabled() {
4142 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004143 scripts/config.py full
4144 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004145 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004146 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004147
Gilles Peskine36dea152023-07-20 22:19:45 +02004148 msg "test: full minus CHACHAPOLY"
4149 make test
4150}
4151
4152component_test_aead_only_ccm() {
4153 msg "build: full minus CHACHAPOLY and GCM"
4154 scripts/config.py full
4155 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4156 scripts/config.py unset MBEDTLS_GCM_C
4157 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4158 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004159 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004160
4161 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004162 make test
4163}
4164
Ronald Crone501d0e2023-07-10 08:31:19 +02004165component_test_ccm_aes_sha256() {
4166 msg "build: CCM + AES + SHA256 configuration"
4167
Ronald Cron7612d8c2023-07-20 10:03:54 +02004168 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004169 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004170
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004171 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004172
4173 msg "test: CCM + AES + SHA256 configuration"
4174 make test
4175}
4176
John Durkopd0321952020-10-29 21:37:36 -07004177# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004178component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004179 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004180 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004181 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004182 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004183 scripts/config.py unset MBEDTLS_ECDH_C
4184 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4185 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4186 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4187 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4188 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4189 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004190 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004191}
4192
4193# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004194component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004195 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004196 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004197 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004198 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004199 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004200 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004201}
4202
4203# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004204component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004205 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004206 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004207 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
4208 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004209 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4210 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004211 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004212 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004213}
4214
John Durkop1b7ee052020-11-27 08:51:22 -08004215# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4216component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004217 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004218 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004219 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004220 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004221 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4222 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4223 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4224 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4225 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4226 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4227 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004228 scripts/config.py unset MBEDTLS_LMS_C
4229 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004230 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004231 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004232}
4233
4234# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4235component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004236 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004237 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004238 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004239 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004240 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4241 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4242 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4243 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4244 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4245 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4246 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004247 scripts/config.py unset MBEDTLS_LMS_C
4248 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004249 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004250 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004251}
4252
4253# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4254component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004255 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004256 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004257 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004258 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004259 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4260 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4261 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4262 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4263 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4264 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4265 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004266 scripts/config.py unset MBEDTLS_LMS_C
4267 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004268 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004269 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004270}
4271
4272# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4273component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004274 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004275 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004276 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004277 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004278 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4279 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4280 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4281 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4282 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4283 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004284 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004285 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004286}
4287
4288# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4289component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004290 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004291 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004292 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004293 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004294 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4295 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4296 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4297 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4298 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4299 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004300 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004301 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004302}
4303
4304# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4305component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004306 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004307 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004308 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004309 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004310 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4311 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4312 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4313 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4314 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4315 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004316 scripts/config.py unset MBEDTLS_LMS_C
4317 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004318 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004319 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004320}
4321
4322# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4323component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004324 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004325 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004326 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004327 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004328 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4329 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4330 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4331 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4332 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4333 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4334 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004335 scripts/config.py unset MBEDTLS_LMS_C
4336 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004337 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004338 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004339}
4340
John Durkopd0321952020-10-29 21:37:36 -07004341# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004342component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004343 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_CRYPT + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopd0321952020-10-29 21:37:36 -07004344 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004345 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004346 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004347 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4348 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4349 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4350 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004351 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004352 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004353}
4354
4355# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004356component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004357 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_SIGN + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004358 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004359 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004360 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004361 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4362 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4363 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4364 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004365 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004366 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004367}
4368
4369# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004370component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004371 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_OAEP + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004372 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004373 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004374 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004375 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4376 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4377 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4378 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004379 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004380 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004381}
4382
4383# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004384component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004385 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PSS + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004386 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004387 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004388 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004389 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4390 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4391 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4392 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004393 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004394 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004395}
4396
4397# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004398component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004399 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_xxx + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004400 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004401 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004402 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004403 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4404 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4405 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4406 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4407 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004408 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004409 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004410}
4411
4412# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004413component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004414 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004415 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004416 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004417 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004418 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4419 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004420 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004421 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004422}
4423
Dave Rodgmanc164c072023-06-28 09:43:23 +01004424
Dave Rodgman904c5892023-06-28 17:36:02 +01004425support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004426 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004427}
4428
Dave Rodgman904c5892023-06-28 17:36:02 +01004429component_build_tfm_armcc() {
4430 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004431 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004432
Dave Rodgman88651c42023-06-29 12:35:51 +01004433 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004434 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 +01004435}
4436
4437component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004438 # Check that the TF-M configuration can build cleanly with various
4439 # warning flags enabled. We don't build or run tests, since the
4440 # TF-M configuration needs a TF-M platform. A tweaked version of
4441 # the configuration that works on mainstream platforms is in
4442 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004443 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004444
Dave Rodgman88651c42023-06-29 12:35:51 +01004445 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004446 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 +01004447
Dave Rodgman904c5892023-06-28 17:36:02 +01004448 msg "build: TF-M config, gcc native build"
4449 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004450 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 +01004451}
4452
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004453# Test that the given .o file builds with all (valid) combinations of the given options.
4454#
4455# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4456#
4457# The validator function is the name of a function to validate the combination of options.
4458# It may be "" if all combinations are valid.
4459# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004460# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004461build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004462 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004463 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004464 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004465 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004466 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004467
Dave Rodgman42436102023-10-03 15:47:05 +01004468 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004469 for opt in "${options[@]}"; do
4470 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004471 done
4472
4473 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004474 cd $(dirname ${file})
4475 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004476
Dave Rodgman920343a2023-10-01 18:41:09 +01004477 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004478 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 +01004479
Dave Rodgman42436102023-10-03 15:47:05 +01004480 # Extract the command generated by the Makefile to build the target file.
4481 # This ensures that we have any include paths, macro definitions, etc
4482 # that may be applied by make.
4483 # 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 +01004484 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004485
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004486 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004487 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004488
Dave Rodgman28e38d82023-10-04 11:50:30 +01004489 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004490 source_file=${file%.o}.c
4491
4492 targets=0
4493 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004494
Dave Rodgman28e38d82023-10-04 11:50:30 +01004495 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004496 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004497 # each bit of $i is used to determine if options[i] will be set or not
4498 target="t"
4499 clang_args=""
4500 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004501 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004502 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004503 clang_args="${clang_args} ${opt}"
4504 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004505 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004506 done
4507
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004508 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004509 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004510 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004511 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004512
Dave Rodgman28e38d82023-10-04 11:50:30 +01004513 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004514 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004515 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004516 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004517
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004518 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004519
Dave Rodgman920343a2023-10-01 18:41:09 +01004520 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004521 make -s -f ${makefile} build_test_config_combos
4522 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004523
4524 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004525 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004526}
4527
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004528validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004529 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4530 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004531 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004532 fi
4533 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4534 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004535 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004536 fi
4537 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004538 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004539}
4540
4541component_build_aes_variations() {
4542 # 18s - around 90ms per clang invocation on M1 Pro
4543 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004544 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004545 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004546
Yanray Wangbc29aef2023-11-06 11:08:17 +08004547 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004548 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004549
Dave Rodgman42436102023-10-03 15:47:05 +01004550 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004551 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4552 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4553 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4554 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004555
4556 cd "$MBEDTLS_ROOT_DIR"
4557 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4558
Yanray Wang42be1ba2023-11-23 14:28:47 +08004559 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004560 # manually set or unset those configurations to check
4561 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004562 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4563 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4564 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4565 scripts/config.py unset MBEDTLS_DES_C
4566 scripts/config.py unset MBEDTLS_NIST_KW_C
4567 build_test_config_combos library/aes.o validate_aes_config_variations \
4568 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4569 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4570 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4571 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004572}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004573
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004574component_test_no_platform () {
4575 # Full configuration build, without platform support, file IO and net sockets.
4576 # This should catch missing mbedtls_printf definitions, and by disabling file
4577 # IO, it should catch missing '#include <stdio.h>'
4578 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004579 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004580 scripts/config.py unset MBEDTLS_PLATFORM_C
4581 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004582 scripts/config.py unset MBEDTLS_FS_IO
4583 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004584 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004585 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004586 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004587 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004588 # to re-enable platform integration features otherwise disabled in C99 builds
4589 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004590 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004591}
Gilles Peskine7c652162017-12-11 00:01:40 +01004592
4593component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004594 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004595 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4596 scripts/config.py full
4597 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004598 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4599 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4600 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4601 make
4602}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004603
Gilles Peskine8f073122018-11-27 15:58:47 +01004604component_build_no_ssl_srv () {
4605 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004606 scripts/config.py full
4607 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004608 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004609}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004610
Gilles Peskine8f073122018-11-27 15:58:47 +01004611component_build_no_ssl_cli () {
4612 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004613 scripts/config.py full
4614 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004615 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004616}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004617
Gilles Peskine8f073122018-11-27 15:58:47 +01004618component_build_no_sockets () {
4619 # Note, C99 compliance can also be tested with the sockets support disabled,
4620 # as that requires a POSIX platform (which isn't the same as C99).
4621 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004622 scripts/config.py full
4623 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4624 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4625 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4626}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004627
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004628component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004629 msg "build: default config with memory buffer allocator and backtrace enabled"
4630 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4631 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4632 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004633 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004634 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004635 make
4636
4637 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4638 make test
4639}
4640
4641component_test_memory_buffer_allocator () {
4642 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004643 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4644 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004645 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004646 make
4647
4648 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4649 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004650
4651 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4652 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004653 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004654}
4655
Gilles Peskine8f073122018-11-27 15:58:47 +01004656component_test_no_max_fragment_length () {
4657 # Run max fragment length tests with MFL disabled
4658 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004659 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004660 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004661 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004662
Gilles Peskine8f073122018-11-27 15:58:47 +01004663 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004664 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004665}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004666
Hanno Becker545ced42019-02-19 11:10:48 +00004667component_test_asan_remove_peer_certificate () {
4668 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004669 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004670 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004671 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004672 make
4673
4674 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4675 make test
4676
4677 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004678 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004679
4680 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004681 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004682
4683 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004684 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004685}
4686
Gilles Peskine8f073122018-11-27 15:58:47 +01004687component_test_no_max_fragment_length_small_ssl_out_content_len () {
4688 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004689 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4690 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4691 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004692 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004693 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004694
Gilles Peskine8f073122018-11-27 15:58:47 +01004695 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004696 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004697
4698 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004699 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004700}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004701
Darryl Greenaad82f92019-12-02 10:53:11 +00004702component_test_variable_ssl_in_out_buffer_len () {
4703 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4704 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004705 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004706 make
4707
4708 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4709 make test
4710
4711 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004712 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004713
4714 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004715 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004716}
4717
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004718component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004719 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004720 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004721
Dave Rodgman17127e92023-12-14 16:42:48 +00004722 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004723 make
4724
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004725 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004726 make test
4727
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004728 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004729 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004730
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004731 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004732 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004733}
4734
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004735component_test_ssl_alloc_buffer_and_mfl () {
4736 msg "build: default config with memory buffer allocator and MFL extension"
4737 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4738 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4739 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4740 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4741 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004742 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004743 make
4744
4745 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4746 make test
4747
4748 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 +02004749 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004750}
4751
Gilles Peskine636c26a2020-03-04 20:46:15 +01004752component_test_when_no_ciphersuites_have_mac () {
4753 msg "build: when no ciphersuites have MAC"
4754 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004755 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004756 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004757 make
4758
4759 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4760 make test
4761
4762 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004763 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004764}
4765
Raoul Strackxa4e86142020-06-15 17:03:13 +02004766component_test_no_date_time () {
4767 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4768 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004769 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004770 make
4771
4772 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4773 make test
4774}
4775
Gilles Peskine8f073122018-11-27 15:58:47 +01004776component_test_platform_calloc_macro () {
4777 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004778 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4779 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4780 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004781 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004782 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004783
Gilles Peskine8f073122018-11-27 15:58:47 +01004784 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4785 make test
4786}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004787
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004788component_test_malloc_0_null () {
4789 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004790 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004791 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 +02004792
4793 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4794 make test
4795
4796 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4797 # Just the calloc selftest. "make test" ran the others as part of the
4798 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004799 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004800
4801 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4802 # Run a subset of the tests. The choice is a balance between coverage
4803 # and time (including time indirectly wasted due to flaky tests).
4804 # The current choice is to skip tests whose description includes
4805 # "proxy", which is an approximation of skipping tests that use the
4806 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004807 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004808}
4809
Dave Rodgman6a08b682023-06-19 11:51:33 +01004810support_test_aesni() {
4811 # Check that gcc targets x86_64 (we can build AESNI), and check for
4812 # AESNI support on the host (we can run AESNI).
4813 #
4814 # The name of this function is possibly slightly misleading, but needs to align
4815 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004816 #
4817 # In principle 32-bit x86 can support AESNI, but our implementation does not
4818 # support 32-bit x86, so we check for x86-64.
4819 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004820 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4821 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004822 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004823}
4824
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004825component_test_aesni () { # ~ 60s
4826 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4827 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4828 #
4829 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4830 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4831 # exercise the plain C impl).
4832
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004833 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004834 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004835 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004836 scripts/config.py set MBEDTLS_HAVE_ASM
4837
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004838 # test the intrinsics implementation
4839 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004840 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004841 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004842 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004843 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004844
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004845 # test the asm implementation
4846 msg "AES tests, test assembly"
4847 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004848 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004849 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004850 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004851
4852 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004853 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004854 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004855 msg "AES tests, plain C"
4856 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004857 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004858 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004859 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004860 not grep -q "AES note: using AESNI" ./programs/test/selftest
4861 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004862
4863 # test the intrinsics implementation
4864 scripts/config.py set MBEDTLS_AESNI_C
4865 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4866 msg "AES tests, test AESNI only"
4867 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004868 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004869 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4870 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004871 grep -q "AES note: using AESNI" ./programs/test/selftest
4872 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004873}
4874
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004875component_test_sha3_variations() {
4876 msg "sha3 loop unroll variations"
4877
4878 # define minimal config sufficient to test SHA3
4879 cat > include/mbedtls/mbedtls_config.h << END
4880 #define MBEDTLS_SELF_TEST
4881 #define MBEDTLS_SHA3_C
4882END
4883
4884 msg "all loops unrolled"
4885 make clean
4886 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"
4887 ./tests/test_suite_shax
4888
4889 msg "all loops rolled up"
4890 make clean
4891 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"
4892 ./tests/test_suite_shax
4893}
4894
Jerry Yub6d39c22023-08-16 15:11:48 +08004895support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004896 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004897}
4898
4899component_test_aesni_m32 () { # ~ 60s
4900 # This tests are duplicated from component_test_aesni for i386 target
4901 #
4902 # AESNI intrinsic code supports i386 and assembly code does not support it.
4903
4904 msg "build: default config with different AES implementations"
4905 scripts/config.py set MBEDTLS_AESNI_C
4906 scripts/config.py set MBEDTLS_PADLOCK_C
4907 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4908 scripts/config.py set MBEDTLS_HAVE_ASM
4909
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004910 # test the intrinsics implementation with gcc
4911 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004912 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004913 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004914 # check that we built intrinsics - this should be used by default when supported by the compiler
4915 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4916 grep -q "AES note: using AESNI" ./programs/test/selftest
4917 grep -q "AES note: built-in implementation." ./programs/test/selftest
4918 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4919 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4920
4921 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004922 scripts/config.py unset MBEDTLS_PADLOCK_C
4923 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4924 msg "AES tests, test AESNI only"
4925 make clean
4926 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4927 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4928 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4929 grep -q "AES note: using AESNI" ./programs/test/selftest
4930 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4931 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4932 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4933}
4934
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004935support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004936 # clang >= 4 is required to build with target attributes
4937 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004938}
4939
4940component_test_aesni_m32_clang() {
4941
4942 scripts/config.py set MBEDTLS_AESNI_C
4943 scripts/config.py set MBEDTLS_PADLOCK_C
4944 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4945 scripts/config.py set MBEDTLS_HAVE_ASM
4946
4947 # test the intrinsics implementation with clang
4948 msg "AES tests, test intrinsics (clang)"
4949 make clean
4950 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4951 # check that we built intrinsics - this should be used by default when supported by the compiler
4952 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4953 grep -q "AES note: using AESNI" ./programs/test/selftest
4954 grep -q "AES note: built-in implementation." ./programs/test/selftest
4955 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4956 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4957}
4958
Jerry Yu193cbc02023-08-03 17:06:29 +08004959# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4960component_build_aes_aesce_armcc () {
4961 msg "Build: AESCE test on arm64 platform without plain C."
4962 scripts/config.py baremetal
4963
4964 # armc[56] don't support SHA-512 intrinsics
4965 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4966
4967 # Stop armclang warning about feature detection for A64_CRYPTO.
4968 # With this enabled, the library does build correctly under armclang,
4969 # but in baremetal builds (as tested here), feature detection is
4970 # unavailable, and the user is notified via a #warning. So enabling
4971 # this feature would prevent us from building with -Werror on
4972 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004973 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004974 scripts/config.py set MBEDTLS_HAVE_ASM
4975
4976 msg "AESCE, build with default configuration."
4977 scripts/config.py set MBEDTLS_AESCE_C
4978 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4979 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4980
4981 msg "AESCE, build AESCE only"
4982 scripts/config.py set MBEDTLS_AESCE_C
4983 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4984 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4985}
4986
Dave Rodgman0c584032023-10-08 12:26:54 +01004987support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004988 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004989 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004990}
4991
4992component_build_aes_armce () {
4993 # Test variations of AES with Armv8 crypto extensions
4994 scripts/config.py set MBEDTLS_AESCE_C
4995 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4996
4997 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004998 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004999
5000 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5001 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5002
5003 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5004 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5005
Dave Rodgman5e419372023-10-23 15:30:20 +01005006 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01005007
Dave Rodgman5e419372023-10-23 15:30:20 +01005008 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
5009 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005010
Dave Rodgman5e419372023-10-23 15:30:20 +01005011 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5012 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01005013
Dave Rodgman5e419372023-10-23 15:30:20 +01005014 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5015 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01005016
5017 # test for presence of AES instructions
5018 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5019 msg "clang, test A32 crypto instructions built"
5020 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5021 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5022 msg "clang, test T32 crypto instructions built"
5023 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5024 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5025 msg "clang, test aarch64 crypto instructions built"
5026 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5027 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
5028
5029 # test for absence of AES instructions
5030 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
5031 scripts/config.py unset MBEDTLS_AESCE_C
5032 msg "clang, test A32 crypto instructions not built"
5033 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5034 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5035 msg "clang, test T32 crypto instructions not built"
5036 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5037 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5038 msg "clang, test aarch64 crypto instructions not built"
5039 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5040 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01005041}
5042
Dave Rodgman9ed18532023-10-05 00:06:47 +01005043support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00005044 # clang >= 4 is required to build with SHA extensions
5045 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01005046}
5047
Dave Rodgmand9e80832023-10-04 17:17:46 +01005048component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01005049 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005050
5051
5052 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01005053 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005054 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
5055 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5056 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
5057 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5058 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005059
Dave Rodgmand9e80832023-10-04 17:17:46 +01005060
Dave Rodgman94a634d2023-10-10 12:59:29 +01005061 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005062 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005063 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
5064 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5065 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005066
Dave Rodgman5b89c552023-10-10 14:59:02 +01005067 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005068 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
5069 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5070 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01005071
Dave Rodgmancd654002023-10-05 09:40:07 +01005072
Dave Rodgman94a634d2023-10-10 12:59:29 +01005073 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005074 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005075 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
5076 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
5077 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
5078 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5079 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005080
Dave Rodgmancd654002023-10-05 09:40:07 +01005081
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005082 # examine the disassembly for presence of SHA instructions
5083 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5084 scripts/config.py set ${opt}
5085 msg "${opt} clang, test A32 crypto instructions built"
5086 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5087 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5088
5089 msg "${opt} clang, test T32 crypto instructions built"
5090 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5091 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5092
5093 msg "${opt} clang, test aarch64 crypto instructions built"
5094 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5095 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5096 scripts/config.py unset ${opt}
5097 done
5098
5099
5100 # examine the disassembly for absence of SHA instructions
5101 msg "clang, test A32 crypto instructions not built"
5102 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5103 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5104
5105 msg "clang, test T32 crypto instructions not built"
5106 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5107 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5108
5109 msg "clang, test aarch64 crypto instructions not built"
5110 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5111 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005112}
5113
Jerry Yuc935aa62023-08-03 17:08:27 +08005114# For timebeing, no VIA Padlock platform available.
5115component_build_aes_via_padlock () {
5116
5117 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005118 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005119 scripts/config.py set MBEDTLS_PADLOCK_C
5120 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005121 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005122 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005123
5124}
5125
5126support_build_aes_via_padlock_only () {
5127 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5128 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5129 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5130}
5131
Jerry Yu193cbc02023-08-03 17:06:29 +08005132support_build_aes_aesce_armcc () {
5133 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005134}
5135
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005136component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005137 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005138 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005139 scripts/config.py unset MBEDTLS_PADLOCK_C
5140
Dave Rodgmand8d64512023-12-19 12:20:21 +00005141 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005142
5143 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5144 make test
5145}
5146
5147component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5148 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5149 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005150 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5151 scripts/config.py unset MBEDTLS_PADLOCK_C
5152
Hanno Becker83ebf782017-07-07 12:29:15 +01005153 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005154
5155 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005156 make test
5157}
Gilles Peskine8f073122018-11-27 15:58:47 +01005158
Hanno Becker83ebf782017-07-07 12:29:15 +01005159component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005160 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5161 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5162 scripts/config.py unset MBEDTLS_PADLOCK_C
5163 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005164 scripts/config.py unset MBEDTLS_AESCE_C
5165
Dave Rodgmand8d64512023-12-19 12:20:21 +00005166 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005167
5168 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005169 make test
5170
5171 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5172 programs/test/selftest
5173}
5174
Matthias Schulz0767fda2024-02-07 10:46:28 +01005175component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005176 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5177 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005178 scripts/config.py unset MBEDTLS_PADLOCK_C
5179 scripts/config.py unset MBEDTLS_AESNI_C
5180 scripts/config.py unset MBEDTLS_AESCE_C
5181
5182 make CFLAGS='-O2 -Werror -Wall -Wextra'
5183
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005184 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005185 make test
5186}
5187
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005188component_test_aes_fewer_tables () {
5189 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005190 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005191 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005192
Gilles Peskine7c652162017-12-11 00:01:40 +01005193 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005194 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005195}
5196
5197component_test_aes_rom_tables () {
5198 msg "build: default config with AES_ROM_TABLES enabled"
5199 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005200 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005201
5202 msg "test: AES_ROM_TABLES"
5203 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005204}
5205
Gilles Peskine14c3c062018-01-29 21:25:12 +01005206component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005207 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5208 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5209 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005210 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005211
Gilles Peskine8f073122018-11-27 15:58:47 +01005212 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5213 make test
5214}
5215
Yanray Wang49cd4b52023-11-10 11:58:37 +08005216# helper for common_block_cipher_no_decrypt() which:
5217# - enable/disable the list of config options passed from -s/-u respectively.
5218# - build
5219# - test for tests_suite_xxx
5220# - selftest
5221#
5222# Usage: helper_block_cipher_no_decrypt_build_test
5223# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5224# Options: -s set_opts the list of config options to enable
5225# -u unset_opts the list of config options to disable
5226# -c cflags the list of options passed to CFLAGS
5227# -l ldflags the list of options passed to LDFLAGS
5228helper_block_cipher_no_decrypt_build_test () {
5229 while [ $# -gt 0 ]; do
5230 case "$1" in
5231 -s)
5232 shift; local set_opts="$1";;
5233 -u)
5234 shift; local unset_opts="$1";;
5235 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005236 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005237 -l)
5238 shift; local ldflags="$1";;
5239 esac
5240 shift
5241 done
5242 set_opts="${set_opts:-}"
5243 unset_opts="${unset_opts:-}"
5244 cflags="${cflags:-}"
5245 ldflags="${ldflags:-}"
5246
Yanray Wangb2d6e522023-11-13 16:57:47 +08005247 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5248 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005249
5250 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5251 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005252 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005253
5254 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5255 not grep mbedtls_aes_setkey_dec library/aes.o
5256 not grep mbedtls_aria_setkey_dec library/aria.o
5257 not grep mbedtls_camellia_setkey_dec library/camellia.o
5258 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5259 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005260 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5261 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005262
5263 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5264 make test
5265
5266 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5267 programs/test/selftest
5268}
5269
5270# This is a common configuration function used in:
5271# - component_test_block_cipher_no_decrypt_aesni_legacy()
5272# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5273# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5274# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5275# on x86.
5276common_block_cipher_no_decrypt () {
5277 # test AESNI intrinsics
5278 helper_block_cipher_no_decrypt_build_test \
5279 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005280 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005281
5282 # test AESNI assembly
5283 helper_block_cipher_no_decrypt_build_test \
5284 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005285 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005286
5287 # test AES C implementation
5288 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005289 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005290
5291 # test AESNI intrinsics for i386 target
5292 helper_block_cipher_no_decrypt_build_test \
5293 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005294 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005295 -l "-m32"
5296}
5297
Yanray Wang3ae11992023-11-13 17:32:09 +08005298# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5299# usage: 0: no PSA crypto configuration
5300# 1: use PSA crypto configuration
5301config_block_cipher_no_decrypt () {
5302 use_psa=$1
5303
Yanray Wang66111392023-10-31 18:54:54 +08005304 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005305 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5306 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005307 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005308 scripts/config.py unset MBEDTLS_NIST_KW_C
5309
Yanray Wang3ae11992023-11-13 17:32:09 +08005310 if [ "$use_psa" -eq 1 ]; then
5311 # Enable support for cryptographic mechanisms through the PSA API.
5312 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5313 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5314 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5315 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5316 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5317 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5318 fi
5319}
5320
5321component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005322 # This consistently causes an llvm crash on clang 3.8, so use gcc
5323 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005324 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005325 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005326}
5327
Yanray Wangf1496402023-11-01 18:55:13 +08005328component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005329 # This consistently causes an llvm crash on clang 3.8, so use gcc
5330 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005331 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005332 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005333}
5334
Yanray Wang66111392023-10-31 18:54:54 +08005335support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005336 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005337}
5338
Yanray Wang66111392023-10-31 18:54:54 +08005339component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005340 scripts/config.py baremetal
5341
5342 # armc[56] don't support SHA-512 intrinsics
5343 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5344
5345 # Stop armclang warning about feature detection for A64_CRYPTO.
5346 # With this enabled, the library does build correctly under armclang,
5347 # but in baremetal builds (as tested here), feature detection is
5348 # unavailable, and the user is notified via a #warning. So enabling
5349 # this feature would prevent us from building with -Werror on
5350 # armclang. Tracked in #7198.
5351 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5352 scripts/config.py set MBEDTLS_HAVE_ASM
5353
Yanray Wang3ae11992023-11-13 17:32:09 +08005354 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005355
5356 # test AESCE baremetal build
5357 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005358 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005359 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005360
Yanray Wangef1b04d2023-09-08 11:09:26 +08005361 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5362 not grep mbedtls_aes_setkey_dec library/aes.o
5363 not grep mbedtls_aria_setkey_dec library/aria.o
5364 not grep mbedtls_camellia_setkey_dec library/camellia.o
5365 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5366 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005367 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005368 not grep mbedtls_aesce_inverse_key library/aesce.o
5369 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005370}
5371
Gilles Peskine592f5912019-10-07 18:49:32 +02005372component_test_ctr_drbg_aes_256_sha_256 () {
5373 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5374 scripts/config.py full
5375 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5376 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005377 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005378 make
5379
5380 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5381 make test
5382}
5383
5384component_test_ctr_drbg_aes_128_sha_512 () {
5385 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005386 scripts/config.py full
5387 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5388 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005389 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005390 make
5391
5392 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5393 make test
5394}
5395
5396component_test_ctr_drbg_aes_128_sha_256 () {
5397 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005398 scripts/config.py full
5399 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5400 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5401 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005402 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005403 make
5404
5405 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5406 make test
5407}
5408
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005409component_test_se_default () {
5410 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005411 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005412 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005413
5414 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5415 make test
5416}
5417
Steven Cooremand57203d2020-07-16 20:28:59 +02005418component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005419 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005420 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005421 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005422 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5423 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005424 loc_cflags="${loc_cflags} -I../tests/include -O2"
5425
Gilles Peskine21570cf2023-12-22 11:49:50 +01005426 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005427
Gilles Peskine1997f302023-07-26 18:45:20 +02005428 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005429 make test
5430}
5431
Gilles Peskine8f073122018-11-27 15:58:47 +01005432component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005433 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005434 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005435 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005436 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005437}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005438
Gilles Peskinecf740502019-07-03 20:43:05 +02005439component_test_cmake_shared () {
5440 msg "build/test: cmake shared" # ~ 2min
5441 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5442 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005443 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005444 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005445 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005446}
5447
Gilles Peskineec10bf12019-09-20 19:56:06 +02005448test_build_opt () {
5449 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005450 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005451 for opt in "$@"; do
5452 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005453 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005454 # We're confident enough in compilers to not run _all_ the tests,
5455 # but at least run the unit tests. In particular, runs with
5456 # optimizations use inline assembly whereas runs with -O0
5457 # skip inline assembly.
5458 make test # ~30s
5459 make clean
5460 done
5461}
5462
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005463# For FreeBSD we invoke the function by name so this condition is added
5464# to disable the existing test_clang_opt function for linux.
5465if [[ $(uname) != "Linux" ]]; then
5466 component_test_clang_opt () {
5467 scripts/config.py full
5468 test_build_opt 'full config' clang -O0 -Os -O2
5469 }
5470fi
5471
5472component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005473 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005474 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005475}
5476support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005477 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005478}
5479
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005480component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005481 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005482 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005483}
5484support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005485 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005486}
5487
5488component_test_gcc_latest_opt () {
5489 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005490 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005491}
5492support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005493 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005494}
5495
5496component_test_gcc_earliest_opt () {
5497 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005498 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005499}
5500support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005501 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005502}
5503
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005504component_build_mbedtls_config_file () {
5505 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005506 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005507 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005508 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005509 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005510 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5511 make clean
5512
5513 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5514 # In the user config, disable one feature (for simplicity, pick a feature
5515 # that nothing else depends on).
5516 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005517 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005518 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5519
5520 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005521}
5522
Gilles Peskine7d904e72022-04-07 21:59:14 +02005523component_build_psa_config_file () {
5524 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5525 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5526 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5527 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5528 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005529 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005530 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5531 make clean
5532
5533 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5534 # In the user config, disable one feature, which will reflect on the
5535 # mbedtls configuration so we can query it with query_compile_time_config.
5536 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5537 scripts/config.py unset MBEDTLS_CMAC_C
5538 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5539 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5540
5541 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005542}
5543
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005544component_build_psa_alt_headers () {
5545 msg "build: make with PSA alt headers" # ~20s
5546
5547 # Generate alternative versions of the substitutable headers with the
5548 # same content except different include guards.
5549 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5550
5551 # Build the library and some programs.
5552 # Don't build the fuzzers to avoid having to go through hoops to set
5553 # a correct include path for programs/fuzz/Makefile.
5554 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
5555 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\"'"
5556
5557 # Check that we're getting the alternative include guards and not the
5558 # original include guards.
5559 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5560 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5561 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5562 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5563}
5564
Dave Rodgman852de3c2023-12-14 14:46:45 +00005565component_test_m32_no_asm () {
5566 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005567 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005568 #
5569 # Note that we require gcc, because clang Asan builds fail to link for
5570 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005571 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005572 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005573 scripts/config.py unset MBEDTLS_HAVE_ASM
5574 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005575 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005576 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005577
Dave Rodgman852de3c2023-12-14 14:46:45 +00005578 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005579 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005580}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005581support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005582 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005583 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005584 *) false;;
5585 esac
5586}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005587
Gilles Peskineff0aee02021-10-05 09:36:03 +02005588component_test_m32_o2 () {
5589 # Build with optimization, to use the i386 specific inline assembly
5590 # and go faster for tests.
5591 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005592 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005593 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005594 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005595
Gilles Peskineff0aee02021-10-05 09:36:03 +02005596 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005597 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005598
Gilles Peskineff0aee02021-10-05 09:36:03 +02005599 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005600 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005601}
Gilles Peskinecf522222021-10-07 19:25:29 +02005602support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005603 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005604}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005605
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005606component_test_m32_everest () {
5607 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005608 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005609 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005610 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005611
5612 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5613 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005614
5615 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005616 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005617
5618 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5619 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005620 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005621}
5622support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005623 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005624}
5625
Gilles Peskine8f073122018-11-27 15:58:47 +01005626component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005627 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005628 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005629 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005630
5631 msg "test: 64-bit ILP32, make, gcc"
5632 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005633}
Gilles Peskine878cf602019-01-06 20:50:38 +00005634support_test_mx32 () {
5635 case $(uname -m) in
5636 amd64|x86_64) true;;
5637 *) false;;
5638 esac
5639}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005640
Peter Kolbus60c6da22018-12-27 06:59:04 -06005641component_test_min_mpi_window_size () {
5642 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005643 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005644 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005645 make
5646
5647 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5648 make test
5649}
5650
Gilles Peskine8f073122018-11-27 15:58:47 +01005651component_test_have_int32 () {
5652 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005653 scripts/config.py unset MBEDTLS_HAVE_ASM
5654 scripts/config.py unset MBEDTLS_AESNI_C
5655 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005656 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005657 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005658
Gilles Peskine8f073122018-11-27 15:58:47 +01005659 msg "test: gcc, force 32-bit bignum limbs"
5660 make test
5661}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005662
Gilles Peskine8f073122018-11-27 15:58:47 +01005663component_test_have_int64 () {
5664 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005665 scripts/config.py unset MBEDTLS_HAVE_ASM
5666 scripts/config.py unset MBEDTLS_AESNI_C
5667 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005668 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005669 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005670
Gilles Peskine8f073122018-11-27 15:58:47 +01005671 msg "test: gcc, force 64-bit bignum limbs"
5672 make test
5673}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005674
Gabor Mezeie256cc12023-07-26 17:28:48 +02005675component_test_have_int32_cmake_new_bignum () {
5676 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5677 scripts/config.py unset MBEDTLS_HAVE_ASM
5678 scripts/config.py unset MBEDTLS_AESNI_C
5679 scripts/config.py unset MBEDTLS_PADLOCK_C
5680 scripts/config.py unset MBEDTLS_AESCE_C
5681 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005682 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005683 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005684
5685 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5686 make test
5687}
5688
Gilles Peskine8f073122018-11-27 15:58:47 +01005689component_test_no_udbl_division () {
5690 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005691 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005692 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005693 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005694
Gilles Peskine8f073122018-11-27 15:58:47 +01005695 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5696 make test
5697}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005698
Gilles Peskine8f073122018-11-27 15:58:47 +01005699component_test_no_64bit_multiplication () {
5700 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005701 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005702 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005703 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005704
Gilles Peskine8f073122018-11-27 15:58:47 +01005705 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5706 make test
5707}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005708
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005709component_test_no_strings () {
5710 msg "build: no strings" # ~10s
5711 scripts/config.py full
5712 # Disable options that activate a large amount of string constants.
5713 scripts/config.py unset MBEDTLS_DEBUG_C
5714 scripts/config.py unset MBEDTLS_ERROR_C
5715 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5716 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005717 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005718
5719 msg "test: no strings" # ~ 10s
5720 make test
5721}
5722
Hanno Beckerc5722d12020-10-09 11:10:42 +01005723component_test_no_x509_info () {
5724 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5725 scripts/config.pl full
5726 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5727 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005728 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005729
5730 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5731 make test
5732
5733 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005734 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005735}
5736
Gilles Peskine8f073122018-11-27 15:58:47 +01005737component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005738 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005739 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005740 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 +02005741
Gilles Peskinee36fe812021-09-01 20:00:33 +02005742 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005743 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005744}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005745
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005746component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005747 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005748 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005749 # Build for a target platform that's close to what Debian uses
5750 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005751 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005752 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005753 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005754 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'
5755
Gilles Peskinee36fe812021-09-01 20:00:33 +02005756 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005757 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005758}
5759support_build_arm_linux_gnueabi_gcc_arm5vte () {
5760 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5761}
5762
5763component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005764 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005765 scripts/config.py baremetal
5766 # This is an imperfect substitute for
5767 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005768 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005769 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 +02005770
Gilles Peskinee36fe812021-09-01 20:00:33 +02005771 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005772 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005773}
5774
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005775component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005776 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5777 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005778 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 +02005779
Gilles Peskinee36fe812021-09-01 20:00:33 +02005780 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005781 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005782 for lib in library/*.a; do
5783 echo "$lib:"
5784 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5785 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005786}
5787
Gilles Peskine8f073122018-11-27 15:58:47 +01005788component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005789 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005790 scripts/config.py baremetal
5791 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005792 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 +01005793 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005794 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005795}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005796
Gilles Peskine8f073122018-11-27 15:58:47 +01005797component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005798 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005799 scripts/config.py baremetal
5800 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005801 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 +01005802 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005803 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005804}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005805
Dave Rodgman8c315f22023-06-02 10:26:24 -04005806component_build_arm_clang_thumb () {
5807 # ~ 30s
5808
5809 scripts/config.py baremetal
5810
5811 msg "build: clang thumb 2, make"
5812 make clean
5813 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5814
5815 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5816 msg "build: clang thumb 1 -O0, make"
5817 make clean
5818 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5819
5820 msg "build: clang thumb 1 -Os, make"
5821 make clean
5822 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5823}
5824
Gilles Peskine8f073122018-11-27 15:58:47 +01005825component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005826 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005827 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005828 # armc[56] don't support SHA-512 intrinsics
5829 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005830
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005831 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5832 scripts/config.py unset MBEDTLS_AESCE_C
5833
Dave Rodgman0fddf822023-03-02 15:32:12 +00005834 # Stop armclang warning about feature detection for A64_CRYPTO.
5835 # With this enabled, the library does build correctly under armclang,
5836 # but in baremetal builds (as tested here), feature detection is
5837 # unavailable, and the user is notified via a #warning. So enabling
5838 # this feature would prevent us from building with -Werror on
5839 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005840 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005841
Hanno Beckerf0762e92022-07-15 12:08:19 +01005842 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005843
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005844 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005845
5846 msg "size: ARM Compiler 5"
5847 "$ARMC5_FROMELF" -z library/*.o
5848
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005849 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005850
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005851 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005852 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005853
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005854 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005855 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5856
5857 # ARM Compiler 6 - Target ARMv7-M+DSP
5858 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005859
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005860 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005861 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005862
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005863 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005864 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005865
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005866 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5867 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5868
Dave Rodgman99318e62023-05-24 12:27:42 +01005869 # ARM Compiler 6 - Target Cortex-M0
5870 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005871
5872 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5873 #
5874 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5875 # that we have in our CI
5876 scripts/config.py set MBEDTLS_AESCE_C
5877 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005878}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005879
Pengyu Lvdf070032023-02-24 16:03:31 +08005880support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005881 armc5_cc="$ARMC5_BIN_DIR/armcc"
5882 armc6_cc="$ARMC6_BIN_DIR/armclang"
5883 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005884}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005885
Ronald Crond2cb7f42024-03-18 12:49:18 +01005886component_test_tls12_only () {
5887 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5888 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5889 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5890 make
5891
5892 msg "test: main suites (inc. selftests) (ASan build)"
5893 make test
5894
5895 msg "test: ssl-opt.sh (ASan build)"
5896 tests/ssl-opt.sh
5897
5898 msg "test: compat.sh (ASan build)"
5899 tests/compat.sh
5900}
5901
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005902component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005903 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005904 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005905 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005906 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5907
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005908 msg "test: TLS 1.3 only, all key exchange modes enabled"
5909 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005910
Ronald Cronc3f43b62022-10-17 17:35:32 +02005911 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5912 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005913}
5914
Ronald Cronc3f43b62022-10-17 17:35:32 +02005915component_test_tls13_only_psk () {
5916 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5917 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5918 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5919 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005920 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005921 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5922 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5923 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5924 scripts/config.py unset MBEDTLS_ECDSA_C
5925 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005926 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005927 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005928 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5929
Ronald Cronc3f43b62022-10-17 17:35:32 +02005930 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5931 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005932
Ronald Cronc3f43b62022-10-17 17:35:32 +02005933 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5934 tests/ssl-opt.sh
5935}
5936
5937component_test_tls13_only_ephemeral () {
5938 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5939 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5940 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005941 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005942 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5943
5944 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5945 cd tests; ./test_suite_ssl; cd ..
5946
5947 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5948 tests/ssl-opt.sh
5949}
5950
Przemek Stekiela01c2422023-06-13 10:46:48 +02005951component_test_tls13_only_ephemeral_ffdh () {
5952 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5953 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5954 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5955 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005956 scripts/config.py unset MBEDTLS_ECDH_C
5957
Przemek Stekiela01c2422023-06-13 10:46:48 +02005958 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5959
5960 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5961 cd tests; ./test_suite_ssl; cd ..
5962
5963 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5964 tests/ssl-opt.sh
5965}
5966
Ronald Cronc3f43b62022-10-17 17:35:32 +02005967component_test_tls13_only_psk_ephemeral () {
5968 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5969 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5970 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5971 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5972 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5973 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5974 scripts/config.py unset MBEDTLS_ECDSA_C
5975 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005976 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005977 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005978 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5979
5980 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5981 cd tests; ./test_suite_ssl; cd ..
5982
5983 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5984 tests/ssl-opt.sh
5985}
5986
Przemek Stekiela01c2422023-06-13 10:46:48 +02005987component_test_tls13_only_psk_ephemeral_ffdh () {
5988 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5989 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5990 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5991 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5992 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5993 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5994 scripts/config.py unset MBEDTLS_ECDSA_C
5995 scripts/config.py unset MBEDTLS_PKCS1_V21
5996 scripts/config.py unset MBEDTLS_PKCS7_C
5997 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005998 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005999 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6000
6001 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6002 cd tests; ./test_suite_ssl; cd ..
6003
6004 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6005 tests/ssl-opt.sh
6006}
6007
Ronald Cronc3f43b62022-10-17 17:35:32 +02006008component_test_tls13_only_psk_all () {
6009 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
6010 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6011 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6012 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6013 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6014 scripts/config.py unset MBEDTLS_ECDSA_C
6015 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00006016 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01006017 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006018 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6019
6020 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6021 cd tests; ./test_suite_ssl; cd ..
6022
6023 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6024 tests/ssl-opt.sh
6025}
6026
6027component_test_tls13_only_ephemeral_all () {
6028 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
6029 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01006030 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006031 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6032
6033 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6034 cd tests; ./test_suite_ssl; cd ..
6035
6036 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6037 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02006038}
6039
Ronald Cron46ac0652024-03-18 12:39:04 +01006040component_test_tls13_no_padding () {
6041 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006042 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01006043 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006044 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006045 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006046 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006047 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01006048 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006049 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006050}
6051
Ronald Cron6f135e12021-12-08 16:57:54 +01006052component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01006053 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006054 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01006055 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006056 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01006057 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006058 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006059 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01006060 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006061 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006062}
6063
Gilles Peskine8f073122018-11-27 15:58:47 +01006064component_build_mingw () {
6065 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006066 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 +00006067
Gilles Peskine8f073122018-11-27 15:58:47 +01006068 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006069 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 +01006070 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02006071
Gilles Peskine8f073122018-11-27 15:58:47 +01006072 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006073 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
6074 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 +01006075 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006076
Pengyu Lv158eead2023-10-19 11:27:05 +08006077 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006078 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08006079 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 +01006080 make WINDOWS_BUILD=1 clean
6081}
Jaeden Amero117b8a42019-04-17 15:19:26 +01006082support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08006083 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
6084 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01006085 *) true;;
6086 esac
6087}
Simon Butcher91aef332016-11-17 09:20:50 +00006088
Gilles Peskine8f073122018-11-27 15:58:47 +01006089component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006090 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02006091 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006092 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6093 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006094
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006095 msg "test: main suites (MSan)" # ~ 10s
6096 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006097
Gilles Peskine6848d172023-11-02 19:58:03 +01006098 msg "test: metatests (MSan)"
6099 tests/scripts/run-metatests.sh any msan
6100
Gilles Peskine82b27272019-06-14 18:27:03 +02006101 msg "program demos (MSan)" # ~20s
6102 tests/scripts/run_demos.py
6103
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006104 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006105 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006106
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006107 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006108
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006109 if [ "$MEMORY" -gt 0 ]; then
6110 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006111 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006112 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006113}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006114
Bence Szépkúti0354d042023-12-06 16:14:37 +01006115component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006116 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006117 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006118 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6119 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006120
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006121 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006122 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006123
Gilles Peskine636c26a2020-03-04 20:46:15 +01006124 # Optional parts (slow; currently broken on OS X because programs don't
6125 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006126 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006127 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006128 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006129 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006130 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006131
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006132 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006133 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006134 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006135 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006136
6137 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006138 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006139 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006140 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006141}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006142
Bence Szépkúti0354d042023-12-06 16:14:37 +01006143component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006144 msg "build: Release, full (clang)"
6145 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6146 scripts/config.py full
6147 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6148 make
6149
6150 msg "test: main suites, Valgrind (full config)"
6151 make memcheck
6152}
6153
Paul Elliott62dc3922021-11-25 17:29:40 +00006154support_test_cmake_out_of_source () {
6155 distrib_id=""
6156 distrib_ver=""
6157 distrib_ver_minor=""
6158 distrib_ver_major=""
6159
6160 # Attempt to parse lsb-release to find out distribution and version. If not
6161 # found this should fail safe (test is supported).
6162 if [[ -f /etc/lsb-release ]]; then
6163
6164 while read -r lsb_line; do
6165 case "$lsb_line" in
6166 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6167 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6168 esac
6169 done < /etc/lsb-release
6170
6171 distrib_ver_major="${distrib_ver%%.*}"
6172 distrib_ver="${distrib_ver#*.}"
6173 distrib_ver_minor="${distrib_ver%%.*}"
6174 fi
6175
6176 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6177 # processor (as the CI does) can create a race condition whereby the build
6178 # fails to see a generated file, despite that file actually having been
6179 # generated. This problem appears to go away with 18.04 or newer, so make
6180 # the out of source tests unsupported on Ubuntu 16.04.
6181 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6182}
6183
Gilles Peskine8f073122018-11-27 15:58:47 +01006184component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006185 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006186 # generates
6187 make neat
6188
Gilles Peskine8f073122018-11-27 15:58:47 +01006189 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006190 MBEDTLS_ROOT_DIR="$PWD"
6191 mkdir "$OUT_OF_SOURCE_DIR"
6192 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006193 # Note: Explicitly generate files as these are turned off in releases
6194 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006195 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006196
Gilles Peskine8f073122018-11-27 15:58:47 +01006197 msg "test: cmake 'out-of-source' build"
6198 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006199 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006200 # Also ensure that there are no error messages such as
6201 # "No such file or directory", which would indicate that some required
6202 # file is missing (ssl-opt.sh tolerates the absence of some files so
6203 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006204 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006205 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006206 cat ssl-opt.err >&2
6207 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006208 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006209 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006210 cd "$MBEDTLS_ROOT_DIR"
6211 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006212}
Andres AGdc192212016-08-31 17:33:13 +01006213
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006214component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006215 # Remove existing generated files so that we use the ones CMake
6216 # generates
6217 make neat
6218
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006219 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006220 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006221 # Note: Explicitly generate files as these are turned off in releases
6222 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006223 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006224 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006225}
Gilles Peskinea3000992022-02-04 00:21:12 +01006226support_test_cmake_as_subdirectory () {
6227 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006228}
6229
Chris Kayd259e342021-03-25 16:03:25 +00006230component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006231 # Remove existing generated files so that we use the ones CMake
6232 # generates
6233 make neat
6234
Chris Kayd259e342021-03-25 16:03:25 +00006235 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006236 cd programs/test/cmake_package
6237 cmake .
6238 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006239 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006240}
Gilles Peskinea3000992022-02-04 00:21:12 +01006241support_test_cmake_as_package () {
6242 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006243}
6244
6245component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006246 # Remove existing generated files so that we use the ones CMake
6247 # generates
6248 make neat
6249
Chris Kayd259e342021-03-25 16:03:25 +00006250 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006251 cd programs/test/cmake_package_install
6252 cmake .
6253 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006254 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006255}
Gilles Peskinea3000992022-02-04 00:21:12 +01006256support_test_cmake_as_package_install () {
6257 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006258}
6259
David Horstmann20550e32023-01-12 14:17:01 +00006260component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006261 # Make a copy of config file to use for the in-tree test
6262 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006263
6264 MBEDTLS_ROOT_DIR="$PWD"
6265 mkdir "$OUT_OF_SOURCE_DIR"
6266 cd "$OUT_OF_SOURCE_DIR"
6267
David Horstmann969c1452023-01-31 10:34:44 +00006268 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006269 cmake "$MBEDTLS_ROOT_DIR"
6270 make
6271
6272 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6273 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006274 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006275 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6276 make
6277
6278 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6279 # In the user config, disable one feature (for simplicity, pick a feature
6280 # that nothing else depends on).
6281 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6282
6283 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6284 make
6285 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6286
6287 rm -f user_config.h full_config.h
6288
6289 cd "$MBEDTLS_ROOT_DIR"
6290 rm -rf "$OUT_OF_SOURCE_DIR"
6291
6292 # Now repeat the test for an in-tree build:
6293
David Horstmann969c1452023-01-31 10:34:44 +00006294 # Restore config for the in-tree test
6295 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006296
David Horstmann969c1452023-01-31 10:34:44 +00006297 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006298 cmake .
6299 make
6300
6301 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6302 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006303 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006304 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6305 make
6306
6307 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6308 # In the user config, disable one feature (for simplicity, pick a feature
6309 # that nothing else depends on).
6310 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6311
6312 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6313 make
6314 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6315
6316 rm -f user_config.h full_config.h
6317}
6318support_build_cmake_custom_config_file () {
6319 support_test_cmake_out_of_source
6320}
6321
6322
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006323component_build_zeroize_checks () {
6324 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6325
6326 scripts/config.py full
6327
6328 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006329 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 +01006330}
6331
6332
Gilles Peskine8f073122018-11-27 15:58:47 +01006333component_test_zeroize () {
6334 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6335 # different combinations of compilers and optimization flags by using an
6336 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6337 # system in all cases that the script fails, so we must manually search the
6338 # output to check whether the pass string is present and no failure strings
6339 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006340
Gilles Peskine4976e822019-01-06 19:52:22 +00006341 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6342 # about a spurious message if Gdb tries and fails, so suppress that.
6343 gdb_disable_aslr=
6344 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6345 gdb_disable_aslr='set disable-randomization off'
6346 fi
6347
Gilles Peskine8f073122018-11-27 15:58:47 +01006348 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006349 for compiler in clang gcc; do
6350 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6351 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006352 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6353 grep "The buffer was correctly zeroized" test_zeroize.log
6354 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006355 rm -f test_zeroize.log
6356 make clean
6357 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006358 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006359}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006360
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006361component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006362 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006363 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006364 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006365
6366 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006367 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006368}
6369
6370support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006371 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006372 ver="$(cmake --version)"
6373 ver="${ver#cmake version }"
6374 ver_major="${ver%%.*}"
6375
6376 ver="${ver#*.}"
6377 ver_minor="${ver%%.*}"
6378
6379 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006380}
6381
Gilles Peskinec848d222022-12-09 12:23:35 +01006382component_check_code_style () {
6383 msg "Check C code style"
6384 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006385}
6386
Gilles Peskinec848d222022-12-09 12:23:35 +01006387support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006388 case $(uncrustify --version) in
6389 *0.75.1*) true;;
6390 *) false;;
6391 esac
6392}
6393
Gilles Peskine8f073122018-11-27 15:58:47 +01006394component_check_python_files () {
6395 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006396 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006397}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006398
Joe Subbianid614c0b2021-07-29 11:18:29 +01006399component_check_test_helpers () {
6400 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006401 # unittest writes out mundane stuff like number or tests run on stderr.
6402 # Our convention is to reserve stderr for actual errors, and write
6403 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006404 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006405
Joe Subbiania25ffab2021-08-06 09:41:27 +01006406 msg "unit test: translate_ciphers.py"
6407 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006408}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006409
Jerry Yud767cc42023-03-31 15:03:55 +08006410
Gilles Peskine192c72f2017-12-21 15:59:21 +01006411################################################################
6412#### Termination
6413################################################################
6414
Gilles Peskine8f073122018-11-27 15:58:47 +01006415post_report () {
6416 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006417 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006418
Gilles Peskine8f073122018-11-27 15:58:47 +01006419 final_report
6420}
6421
6422
6423
6424################################################################
6425#### Run all the things
6426################################################################
6427
Gilles Peskine5d996822020-03-28 21:09:21 +01006428# Function invoked by --error-test to test error reporting.
6429pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006430 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006431 if [ $KEEP_GOING -ne 0 ]; then
6432 echo "Expect three failing commands."
6433 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006434 # If the component doesn't run in a subshell, changing error_test_i to an
6435 # invalid integer will cause an error in the loop that runs this function.
6436 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006437 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006438 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006439 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006440 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006441 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006442 make unknown_target
6443 false "this should not be executed"
6444}
6445
Gilles Peskinee48351a2018-11-27 16:06:30 +01006446# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006447run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006448 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006449 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006450
6451 # Unconditionally create a seedfile that's sufficiently long.
6452 # Do this before each component, because a previous component may
6453 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006454 local dd_cmd
6455 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6456 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006457 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006458 esac
6459 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006460
Gilles Peskineec135542021-08-02 23:14:03 +02006461 # Run the component in a subshell, with error trapping and output
6462 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006463 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006464 # We want to keep running if the subshell fails, so 'set -e' must
6465 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006466 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006467 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006468 (
6469 if [ $QUIET -eq 1 ]; then
6470 # msg() will be silenced, so just print the component name here.
6471 echo "${current_component#component_}"
6472 exec >/dev/null
6473 fi
6474 if [ $KEEP_GOING -eq 1 ]; then
6475 # Keep "set -e" off, and run an ERR trap instead to record failures.
6476 set -E
6477 trap err_trap ERR
6478 fi
6479 # The next line is what runs the component
6480 "$@"
6481 if [ $KEEP_GOING -eq 1 ]; then
6482 trap - ERR
6483 exit $last_failure_status
6484 fi
6485 )
6486 component_status=$?
6487 if [ $KEEP_GOING -eq 1 ]; then
6488 set -e
6489 if [ $component_status -ne 0 ]; then
6490 failure_count=$((failure_count + 1))
6491 fi
6492 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006493
6494 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006495 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006496 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006497}
6498
6499# Preliminary setup
6500pre_check_environment
6501pre_initialize_variables
6502pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006503
Dave Rodgman21900632024-02-26 11:41:19 +00006504setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006505pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006506pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006507pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006508
Gilles Peskine878cf602019-01-06 20:50:38 +00006509build_status=0
6510if [ $KEEP_GOING -eq 1 ]; then
6511 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006512fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006513pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006514pre_print_configuration
6515pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006516cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006517if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006518 pre_generate_files
6519fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006520
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006521# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006522for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006523 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006524done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006525unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006526for component in $RUN_COMPONENTS; do
6527 run_component "component_$component"
6528done
Gilles Peskine8f073122018-11-27 15:58:47 +01006529
6530# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006531post_report