blob: 1328eebfec45b94a672b831a1c5a60fdf19501bc [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
Ronald Cron7e5d61c2024-06-10 14:25:46 +0200136 CRYPTO_CONFIG_H='tf-psa-crypto/include/psa/crypto_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100137 else
138 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
Ronald Cron7e5d61c2024-06-10 14:25:46 +0200139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100140 fi
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100141 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200142
143 # Files that are clobbered by some jobs will be backed up. Use a different
144 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
145 # independently decide when to remove the backup file.
146 backup_suffix='.all.bak'
147 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100148 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100149 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100150 # Files clobbered by in-tree cmake
151 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
152 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200153
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200154 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100155 MEMORY=0
156 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200157 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100158 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100159
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200160 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200161 #
162 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
163 # both values are kept in sync. If you change the value here because it
164 # breaks some tests, you'll definitely want to change it in
165 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200166 RELEASE_SEED=1
167
Yanray Wang18040ed2023-11-23 21:29:56 +0800168 # Specify character collation for regular expressions and sorting with C locale
169 export LC_COLLATE=C
170
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200171 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200172 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200173 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200174 export MBEDTLS_TEST_PLATFORM
175
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000176 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100178 : ${OPENSSL_NEXT:="$OPENSSL"}
179 : ${GNUTLS_CLI:="gnutls-cli"}
180 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100181 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
182 : ${ARMC5_BIN_DIR:=/usr/bin}
183 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200184 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200185 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100186 : ${CLANG_LATEST:="clang-latest"}
187 : ${CLANG_EARLIEST:="clang-earliest"}
188 : ${GCC_LATEST:="gcc-latest"}
189 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100190 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000191 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200192 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100193 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000194 # if CC is not set, use clang by default (if present) to improve build times
195 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000196 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000197 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000198
Ronald Cronc5e81d22024-04-02 14:39:53 +0200199 if [ -n "${OPENSSL_3+set}" ]; then
200 export OPENSSL_NEXT="$OPENSSL_3"
201 fi
202
Gilles Peskine396853a2021-09-20 18:57:55 +0200203 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000204 export CTEST_OUTPUT_ON_FAILURE=1
205
Gilles Peskine8fd59422019-10-21 17:11:33 +0200206 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100207 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200208 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000209 # Normally, tests should use this compiler for ASAN testing
210 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200211
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400212 # Platform tests have an allocation that returns null
213 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400214 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400215
Gilles Peskine878cf602019-01-06 20:50:38 +0000216 # Gather the list of available components. These are the functions
217 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100218 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000219
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000220 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100221 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100222}
Andres AG38495a32016-07-12 16:54:33 +0100223
Dave Rodgman21900632024-02-26 11:41:19 +0000224setup_quiet_wrappers()
225{
226 # Pick up "quiet" wrappers for make and cmake, which don't output very much
227 # unless there is an error. This reduces logging overhead in the CI.
228 #
229 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000230 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
231 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000232 fi
233}
234
Gilles Peskinea28db922019-01-10 00:05:18 +0100235# Test whether the component $1 is included in the command line patterns.
236is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100237{
Gilles Peskine03af6782021-08-06 11:35:17 +0200238 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
239 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100240 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000241 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100242 set +f
243 case ${1#component_} in $pattern) return 0;; esac
244 done
245 set +f
246 return 1
247}
Andres AG7770ea82016-10-10 15:46:20 +0100248
Simon Butcher41eeccf2016-09-07 00:07:09 +0100249usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100250{
Gilles Peskine709346a2017-12-10 23:43:39 +0100251 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100252Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100253Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100254By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100255COMPONENT can be the name of a component or a shell wildcard pattern.
256
257Examples:
258 $0 "check_*"
259 Run all sanity checks.
260 $0 --no-armcc --except test_memsan
261 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100262
263Special options:
264 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000265 --list-all-components List all available test components and exit.
266 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100267
268General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200269 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100270 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100271 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100272 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200273 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200274 --arm-none-eabi-gcc-prefix=<string>
275 Prefix for a cross-compiler for arm-none-eabi
276 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200277 --arm-linux-gnueabi-gcc-prefix=<string>
278 Prefix for a cross-compiler for arm-linux-gnueabi
279 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100280 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200281 --restore First clean up the build tree, restoring backed up
282 files. Do not run any components unless they are
283 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100284 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200285 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100286 --except Exclude the COMPONENTs listed on the command line,
287 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200288 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100289 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100290 --no-force Refuse to overwrite modified files (default).
291 --no-keep-going Stop at the first error (default).
292 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800293 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100294 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200295 --outcome-file=<path> File where test outcomes are written (not done if
296 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100297 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200298 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100299 -s|--seed Integer seed value to use for this test run.
300
301Tool path options:
302 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
303 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100304 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
305 --clang-latest=<Clang_latest_path> Latest version of clang available
306 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
307 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100308 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
309 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100310 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100311 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100312EOF
SimonB2e23c822016-04-16 21:54:39 +0100313}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100314
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200315# Cleanup before/after running a component.
316# Remove built files as well as the cmake cache/config.
317# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100318cleanup()
319{
David Horstmann76a77382023-08-17 17:32:26 +0100320 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100321 command make clean
322 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200323
Gilles Peskine31b07e22018-03-21 12:15:06 +0100324 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000325 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100326 -iname CMakeFiles -exec rm -rf {} \+ -o \
327 \( -iname cmake_install.cmake -o \
328 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200329 -iname CMakeCache.txt -o \
330 -path './cmake/*.cmake' \) -exec rm -f {} \+
Ronald Cron5cdc22b2024-06-12 10:04:22 +0200331 # Remove Makefiles generated by in-tree CMake builds
332 rm -f 3rdparty/Makefile 3rdparty/*/Makefile pkgconfig/Makefile framework/Makefile
333 rm -f include/Makefile programs/!(fuzz)/Makefile
Ronald Cron30ea2b92024-06-11 14:07:09 +0200334 rm -f tf-psa-crypto/Makefile tf-psa-crypto/include/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200335
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100336 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
337 rm -rf programs/test/cmake_subproject/build
338 rm -f programs/test/cmake_subproject/Makefile
339 rm -f programs/test/cmake_subproject/cmake_subproject
340
Chris Kayd259e342021-03-25 16:03:25 +0000341 # Remove any artifacts from the component_test_cmake_as_package test.
342 rm -rf programs/test/cmake_package/build
343 rm -f programs/test/cmake_package/Makefile
344 rm -f programs/test/cmake_package/cmake_package
345
346 # Remove any artifacts from the component_test_cmake_as_installed_package test.
347 rm -rf programs/test/cmake_package_install/build
348 rm -f programs/test/cmake_package_install/Makefile
349 rm -f programs/test/cmake_package_install/cmake_package_install
350
Gilles Peskinef83eb822020-03-30 20:11:39 +0200351 # Restore files that may have been clobbered by the job
352 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200353 if [[ -e "$x$backup_suffix" ]]; then
354 cp -p "$x$backup_suffix" "$x"
355 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200356 done
357}
John Durkopbd069d32020-10-31 22:14:03 -0700358
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200359# Final cleanup when this script exits (except when exiting on a failure
360# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200361final_cleanup () {
362 cleanup
363
364 for x in $files_to_back_up; do
365 rm -f "$x$backup_suffix"
366 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100367}
368
Gilles Peskine7c652162017-12-11 00:01:40 +0100369# Executed on exit. May be redefined depending on command line options.
370final_report () {
371 :
372}
373
374fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200375 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100376 final_report $1
377 trap - $1
378 kill -$1 $$
379}
380
381trap 'fatal_signal HUP' HUP
382trap 'fatal_signal INT' INT
383trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200384
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200385# Number of processors on this machine. Used as the default setting
386# for parallel make.
387all_sh_nproc ()
388{
389 {
390 nproc || # Linux
391 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
392 sysctl -n hw.ncpu || # FreeBSD
393 echo 1
394 } 2>/dev/null
395}
396
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100397msg()
398{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100399 if [ -n "${current_component:-}" ]; then
400 current_section="${current_component#component_}: $1"
401 else
402 current_section="$1"
403 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200404
405 if [ $QUIET -eq 1 ]; then
406 return
407 fi
408
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100409 echo ""
410 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100411 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000412 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100413 echo "******************************************************************"
414}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100415
Gilles Peskine8f073122018-11-27 15:58:47 +0100416armc6_build_test()
417{
418 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100419
Gilles Peskine18487f62020-04-30 23:11:54 +0200420 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800421 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100422 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000423 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200424
425 msg "size: ARM Compiler 6 ($FLAGS)"
426 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100427}
Andres AGa5cd9732016-10-17 15:23:10 +0100428
Andres AGd9eba4b2016-08-26 14:42:14 +0100429err_msg()
430{
431 echo "$1" >&2
432}
433
434check_tools()
435{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200436 for tool in "$@"; do
437 if ! `type "$tool" >/dev/null 2>&1`; then
438 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100439 exit 1
440 fi
441 done
442}
443
Gilles Peskine8f073122018-11-27 15:58:47 +0100444pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000445 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100446 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100447 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100448 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200449 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000450 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100451
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000452 # Note that legacy options are ignored instead of being omitted from this
453 # list of options, so invocations that worked with previous version of
454 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100455 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100456 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200457 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200458 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200459 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000460 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100461 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
462 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100463 --clang-earliest) shift; CLANG_EARLIEST="$1";;
464 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100465 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000466 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100468 --gcc-earliest) shift; GCC_EARLIEST="$1";;
469 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200471 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
472 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100473 --gnutls-serv) shift; GNUTLS_SERV="$1";;
474 --help|-h) usage; exit;;
475 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000476 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100477 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200479 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000480 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 --no-force) FORCE=0;;
482 --no-keep-going) KEEP_GOING=0;;
483 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200484 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200487 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100488 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200489 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200491 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200492 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 --seed|-s) shift; SEED="$1";;
494 -*)
495 echo >&2 "Unknown option: $1"
496 echo >&2 "Run $0 --help for usage."
497 exit 120
498 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000499 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100500 esac
501 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100502 done
SimonB2e23c822016-04-16 21:54:39 +0100503
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100504 # Exclude components that are not supported on this platform.
505 SUPPORTED_COMPONENTS=
506 for component in $ALL_COMPONENTS; do
507 case $(type "support_$component" 2>&1) in
508 *' function'*)
509 if ! support_$component; then continue; fi;;
510 esac
511 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
512 done
513
514 if [ $list_components -eq 1 ]; then
515 printf '%s\n' $SUPPORTED_COMPONENTS
516 exit
517 fi
518
Gilles Peskinea28db922019-01-10 00:05:18 +0100519 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200520 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000521 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100522 fi
523
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
525 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100526 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000527 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100528 fi
SimonB2e23c822016-04-16 21:54:39 +0100529
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200530 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100531 if [ $all_except -eq 0 ]; then
532 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200533 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
534 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200535 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100536 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200537 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200538 # If the requested name includes a wildcard character, don't
539 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100540 case $component in
541 *[*?\[]*) continue;;
542 esac
543 case " $SUPPORTED_COMPONENTS " in
544 *" $component "*) :;;
545 *)
546 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
547 unsupported=$((unsupported + 1));;
548 esac
549 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200550 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100551 if [ $unsupported -ne 0 ]; then
552 exit 2
553 fi
554 fi
555
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000556 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100557 RUN_COMPONENTS=
558 for component in $SUPPORTED_COMPONENTS; do
559 if is_component_included "$component"; [ $? -eq $all_except ]; then
560 RUN_COMPONENTS="$RUN_COMPONENTS $component"
561 fi
562 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000563
564 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000565 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100566}
SimonB2e23c822016-04-16 21:54:39 +0100567
Gilles Peskine8f073122018-11-27 15:58:47 +0100568pre_check_git () {
569 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100570 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100571 git checkout-index -f -q $CONFIG_H
572 cleanup
573 else
SimonB2e23c822016-04-16 21:54:39 +0100574
Gilles Peskine8f073122018-11-27 15:58:47 +0100575 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
576 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
577 echo "You can either delete this directory manually, or force the test by rerunning"
578 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
579 exit 1
580 fi
581
Ronald Cron7a93ac52023-07-20 09:49:12 +0200582 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100583 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100584 echo "You can either delete or preserve your work, or force the test by rerunning the"
585 echo "script as: $0 --force"
586 exit 1
587 fi
SimonB2e23c822016-04-16 21:54:39 +0100588 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500589}
590
Gilles Peskine568f53a2021-07-12 18:16:01 +0200591pre_restore_files () {
592 # If the makefiles have been generated by a framework such as cmake,
593 # restore them from git. If the makefiles look like modifications from
594 # the ones checked into git, take care not to modify them. Whatever
595 # this function leaves behind is what the script will restore before
596 # each component.
597 case "$(head -n1 Makefile)" in
598 *[Gg]enerated*)
599 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
600 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
601 ;;
602 esac
603}
604
Gilles Peskinef83eb822020-03-30 20:11:39 +0200605pre_back_up () {
606 for x in $files_to_back_up; do
607 cp -p "$x" "$x$backup_suffix"
608 done
609}
610
Gilles Peskine8f073122018-11-27 15:58:47 +0100611pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100612 failure_count=0 # Number of failed components
613 last_failure_status=0 # Last failure status in this component
614
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100615 # See err_trap
616 previous_failure_status=0
617 previous_failed_command=
618 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100619 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100620
Gilles Peskine7c652162017-12-11 00:01:40 +0100621 start_red=
622 end_color=
623 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100624 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100625 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
626 start_red=$(printf '\033[31m')
627 end_color=$(printf '\033[0m')
628 ;;
629 esac
630 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100631
632 # Keep a summary of failures in a file. We'll print it out at the end.
633 failure_summary_file=$PWD/all-sh-failures-$$.log
634 : >"$failure_summary_file"
635
636 # Whether it makes sense to keep a component going after the specified
637 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200638 # This function normally receives the failing simple command
639 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
640 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100641 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200642 # False positives result in running things that can't be expected to
643 # work. False negatives result in things not running after something else
644 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100645 can_keep_going_after_failure () {
646 case "$1" in
647 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200648 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100649 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200650 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
651 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
652 *make*check*) true;;
653 "grep "*) true;;
654 "[ "*) true;;
655 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100656 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100657 esac
658 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100659
660 # This function runs if there is any error in a component.
661 # It must either exit with a nonzero status, or set
662 # last_failure_status to a nonzero value.
663 err_trap () {
664 # Save $? (status of the failing command). This must be the very
665 # first thing, before $? is overridden.
666 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100667 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100668
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100669 if [[ $last_failure_status -eq $previous_failure_status &&
670 "$failed_command" == "$previous_failed_command" &&
671 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
672 then
673 # The same command failed twice in a row, but this time one level
674 # less deep in the function call stack. This happens when the last
675 # command of a function returns a nonzero status, and the function
676 # returns that same status. Ignore the second failure.
677 previous_failure_funcall_depth=${#FUNCNAME[@]}
678 return
679 fi
680 previous_failure_status=$last_failure_status
681 previous_failed_command=$failed_command
682 previous_failure_funcall_depth=${#FUNCNAME[@]}
683
Gilles Peskinece266c42020-03-28 18:50:43 +0100684 text="$current_section: $failed_command -> $last_failure_status"
685 echo "${start_red}^^^^$text^^^^${end_color}" >&2
686 echo "$text" >>"$failure_summary_file"
687
688 # If the command is fatal (configure or build command), stop this
689 # component. Otherwise (test command) keep the component running
690 # (run more tests from the same build).
691 if ! can_keep_going_after_failure "$failed_command"; then
692 exit $last_failure_status
693 fi
694 }
695
Gilles Peskine7c652162017-12-11 00:01:40 +0100696 final_report () {
697 if [ $failure_count -gt 0 ]; then
698 echo
699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100700 echo "${start_red}FAILED: $failure_count components${end_color}"
701 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100702 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
703 elif [ -z "${1-}" ]; then
704 echo "SUCCESS :)"
705 fi
706 if [ -n "${1-}" ]; then
707 echo "Killed by SIG$1."
708 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100709 rm -f "$failure_summary_file"
710 if [ $failure_count -gt 0 ]; then
711 exit 1
712 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100713 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100714}
715
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200716# record_status() and if_build_succeeded() are kept temporarily for backward
717# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100718record_status () {
719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
Gilles Peskine7c652162017-12-11 00:01:40 +0100721if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100722 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100723}
724
Gilles Peskinea681c592020-03-28 21:27:40 +0100725# '! true' does not trigger the ERR trap. Arrange to trigger it, with
726# a reasonably informative error message (not just "$@").
727not () {
728 if "$@"; then
729 report_failed_command="! $*"
730 false
731 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200732 fi
733}
734
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200735pre_prepare_outcome_file () {
736 case "$MBEDTLS_TEST_OUTCOME_FILE" in
737 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
738 esac
739 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
740 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
741 fi
742}
743
Gilles Peskine8f073122018-11-27 15:58:47 +0100744pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200745 if [ $QUIET -eq 1 ]; then
746 return
747 fi
748
Gilles Peskine8f073122018-11-27 15:58:47 +0100749 msg "info: $0 configuration"
750 echo "MEMORY: $MEMORY"
751 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200752 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100754 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100755 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
757 echo "GNUTLS_CLI: $GNUTLS_CLI"
758 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100759 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
760 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
761}
Andres AG7770ea82016-10-10 15:46:20 +0100762
Andres AGd9eba4b2016-08-26 14:42:14 +0100763# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100764pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000765 # Build the list of variables to pass to output_env.sh.
766 set env
SimonB2e23c822016-04-16 21:54:39 +0100767
Gilles Peskine87964262019-01-06 22:40:00 +0000768 case " $RUN_COMPONENTS " in
769 # Require OpenSSL and GnuTLS if running any tests (as opposed to
770 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
771 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100772 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000773 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
774 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100775 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000776 export GNUTLS_CLI="$GNUTLS_CLI"
777 export GNUTLS_SERV="$GNUTLS_SERV"
778 # Avoid passing --seed flag in every call to ssl-opt.sh
779 if [ -n "${SEED-}" ]; then
780 export SEED
781 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200782 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000783 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200784 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
785 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000786 ;;
787 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200788
Gilles Peskine87964262019-01-06 22:40:00 +0000789 case " $RUN_COMPONENTS " in
790 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
791 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100792
Gilles Peskine87964262019-01-06 22:40:00 +0000793 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200794 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000795 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100796
Gilles Peskine87964262019-01-06 22:40:00 +0000797 case " $RUN_COMPONENTS " in
798 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
799 esac
800
801 case " $RUN_COMPONENTS " in
802 *" test_zeroize "*) check_tools "gdb";;
803 esac
804
805 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000806 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
808 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000810 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
811 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200812 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
813 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
814 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000815 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000816
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200817 # past this point, no call to check_tool, only printing output
818 if [ $QUIET -eq 1 ]; then
819 return
820 fi
821
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000822 msg "info: output_env.sh"
823 case $RUN_COMPONENTS in
824 *_armcc*)
825 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
826 *) set "$@" RUN_ARMCC=0;;
827 esac
828 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100829}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100830
Gilles Peskine1570b592021-04-22 01:10:12 +0200831pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200832 # since make doesn't have proper dependencies, remove any possibly outdate
833 # file that might be around before generating fresh ones
834 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200835 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200836 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200837 else
838 make generated_files
839 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200840}
841
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000842clang_version() {
843 if command -v clang > /dev/null ; then
844 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
845 else
846 echo 0 # report version 0 for "no clang"
847 fi
848}
849
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200850################################################################
851#### Helpers for components using libtestdriver1
852################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100853
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200854# How to use libtestdriver1
855# -------------------------
856#
857# 1. Define the list algorithms and key types to accelerate,
858# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
859# Examples:
860# - loc_accel_list="ALG_JPAKE"
861# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200862# 2. Make configurations changes for the driver and/or main libraries.
863# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
864# can be either "default" to start with the default config, or a name
865# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200866# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200867# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
868# These changes affect both the driver and the main libraries.
869# (Note: they need to have the same set of PSA_WANT symbols, as that
870# determines the ABI between them.)
871# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
872# main libraries. Typically, you want to disable the module(s) that are
873# being accelerated. You may need to also disable modules that depend
874# on them or options that are not supported with drivers.
875# 2d. On top of psa/crypto_config.h, the driver library uses its own config
876# file: tests/include/test/drivers/config_test_driver.h. You usually
877# don't need to edit it: using loc_extra_list (see below) is preferred.
878# However, when there's no PSA symbol for what you want to enable,
879# calling scripts/config.py on this file remains the only option.
880# 3. Build the driver library, then the main libraries, test, and programs.
881# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
882# need to enable more algorithms here, typically hash algorithms when
883# accelerating some signature algorithms (ECDSA, RSAv2). This is done
884# by passing a 2nd argument listing the extra algorithms.
885# Example:
886# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
887# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800888# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200889# additional arguments will be passed to make: this can be useful if
890# you don't want to build everything when iterating during development.
891# Example:
892# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
893# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200894
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200895# Adjust the configuration - for both libtestdriver1 and main library,
896# as they should have the same PSA_WANT macros.
897helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200898 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200900 if [ "$base_config" != "default" ]; then
901 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200902 fi
903
904 # Enable PSA-based config (necessary to use drivers)
905 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
906
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200907 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
908 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
909 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000910
911 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
912 # otherwise we will end up running multithreaded tests without mutexes to protect them.
913 if scripts/config.py get MBEDTLS_THREADING_C; then
914 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
915 fi
916
917 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
918 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
919 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200920}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100921
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100922# Build the drivers library libtestdriver1.a (with ASan).
923#
924# Parameters:
925# 1. a space-separated list of things to accelerate;
926# 2. optional: a space-separate list of things to also support.
927# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
928helper_libtestdriver1_make_drivers() {
929 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
930 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
931}
932
933# Build the main libraries, programs and tests,
934# linking to the drivers library (with ASan).
935#
936# Parameters:
937# 1. a space-separated list of things to accelerate;
938# *. remaining arguments if any are passed directly to make
939# (examples: lib, -C tests test_suite_xxx, etc.)
940# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
941helper_libtestdriver1_make_main() {
942 loc_accel_list=$1
943 shift
944
945 # we need flags both with and without the LIBTESTDRIVER1_ prefix
946 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
947 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
948 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
949}
950
Valerio Settid1b6ef12024-05-07 16:00:21 +0200951# $1: target which can be "client" or "server"
952helper_crypto_client_build() {
953 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200954 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200955 TARGET_LIB=libpsa$TARGET
956
Valerio Settid1b6ef12024-05-07 16:00:21 +0200957 if [ "$TARGET" == "client" ]; then
958 scripts/config.py full
959 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
960 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
961 # Dynamic secure element support is a deprecated feature and it is not
962 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
963 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
964 # Disable potentially problematic features
965 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
966 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
967 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
968 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
969 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100970 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200971 else
972 scripts/config.py crypto_full
973 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +0100974 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
975 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
976 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
977 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200978 fi
979
Valerio Settif57afd52024-05-14 10:39:20 +0200980 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200981}
982
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100983################################################################
984#### Configuration helpers
985################################################################
986
Valerio Settib2fd6732023-08-15 17:10:47 +0200987# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200988# The function optionally accepts 1 parameter: a space-separated list of the
989# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200990helper_disable_builtin_curves() {
991 allowed_list="${1:-}"
992 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
993
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200994 for curve in $allowed_list; do
995 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200996 done
997}
998
999# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1000# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1001# in the following helpers.
1002helper_get_psa_curve_list () {
1003 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001004 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1005 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001006 done
1007
1008 echo "$loc_list"
1009}
1010
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001011# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1012# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1013# in the following helpers.
1014helper_get_psa_dh_group_list () {
1015 loc_list=""
1016 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1017 loc_list="$loc_list $item"
1018 done
1019
1020 echo "$loc_list"
1021}
1022
Valerio Settib2fd6732023-08-15 17:10:47 +02001023# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001024# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001025# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001026helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001027 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001028 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001029 for item in $(sed -n "s/^#define PSA_WANT_\(KEY_TYPE_${key_type}_[0-9A-Z_a-z]*\).*/\1/p" <"$CRYPTO_CONFIG_H"); do
Valerio Settib2fd6732023-08-15 17:10:47 +02001030 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1031 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001032 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1033 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001034 fi
1035 done
1036
1037 echo "$loc_list"
1038}
1039
Gilles Peskine192c72f2017-12-21 15:59:21 +01001040################################################################
1041#### Basic checks
1042################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001043
1044#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001045# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001046#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001047# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001048# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001049# and/or are more likely to fail than others (eg I use Clang most of the
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001050# time, so start with a GCC build).
1051# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001052#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001053# Indicative running times are given for reference.
1054
Gilles Peskine8f073122018-11-27 15:58:47 +01001055component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001056 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001057 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001058}
Janos Follathb72c6782016-07-19 14:54:17 +01001059
Gilles Peskine67debb62021-05-18 16:09:50 +02001060component_check_generated_files () {
1061 msg "Check: check-generated-files, files generated with make" # 2s
1062 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001063 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001064
1065 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001066 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001067 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001068 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001069
1070 msg "Check: check-generated-files -u, files absent" # 2s
1071 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001072 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001073 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001074 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001075
1076 # This component ends with the generated files present in the source tree.
1077 # This is necessary for subsequent components!
1078}
1079
Gilles Peskine8f073122018-11-27 15:58:47 +01001080component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001081 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001082 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001083}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001084
Gilles Peskine8f073122018-11-27 15:58:47 +01001085component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001086 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001087 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001088}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001089
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001090component_check_changelog () {
1091 msg "Check: changelog entries" # < 1s
1092 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001093 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001094 if [ -e ChangeLog.new ]; then
1095 # Show the diff for information. It isn't an error if the diff is
1096 # non-empty.
1097 diff -u ChangeLog ChangeLog.new || true
1098 rm ChangeLog.new
1099 fi
1100}
1101
Gilles Peskine8f073122018-11-27 15:58:47 +01001102component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001103 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001104 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001105}
Darryl Greena07039c2018-03-13 16:48:16 +00001106
Gilles Peskine895868b2019-09-19 21:30:05 +02001107component_check_test_cases () {
1108 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001109 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001110 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001111 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001112 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001113 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001114 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001115 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001116}
1117
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001118component_check_test_dependencies () {
1119 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001120 # The purpose of this component is to catch unjustified dependencies on
1121 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1122 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1123 # MBEDTLS_PSA_xxx).
1124 #
1125 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1126 # this component is meant to catch. However a few of them are justified,
1127 # mostly by the absence of a PSA equivalent, so this component includes a
1128 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001129
1130 found="check-test-deps-found-$$"
1131 expected="check-test-deps-expected-$$"
1132
1133 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001134 grep 'depends_on' \
1135 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001136 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001137 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001138 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001139
Yanray Wang18040ed2023-11-23 21:29:56 +08001140 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001141 rm -f $expected
1142 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1143 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001144 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1145 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001146 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1147 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001148 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1149 # the test code and that's probably the most convenient way of achieving
1150 # the test's goal.
1151 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1152 # No PSA equivalent - we should probably have one in the future.
1153 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1154 # No PSA equivalent - needed by some init tests
1155 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001156 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001157 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001158
1159 # Compare reality with expectation.
1160 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001161 #
1162 # The output should be empty. When it's not:
1163 # - Each '+' line is a macro that was found but not expected. You want to
1164 # find where that macro occurs, and either replace it with PSA macros, or
1165 # add it to the exceptions list above with a justification.
1166 # - Each '-' line is a macro that was expected but not found; it means the
1167 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001168 diff -U0 $expected $found
1169
1170 rm $found $expected
1171}
1172
Gilles Peskine8f073122018-11-27 15:58:47 +01001173component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001174 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001175 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001176}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001177
Gilles Peskine192c72f2017-12-21 15:59:21 +01001178
Gilles Peskine636c26a2020-03-04 20:46:15 +01001179
Gilles Peskine192c72f2017-12-21 15:59:21 +01001180################################################################
1181#### Build and test many configurations and targets
1182################################################################
1183
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001184component_test_default_out_of_box () {
1185 msg "build: make, default config (out-of-box)" # ~1min
1186 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001187 # Disable fancy stuff
1188 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001189
1190 msg "test: main suites make, default config (out-of-box)" # ~10s
1191 make test
1192
1193 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001194 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001195
1196 msg "program demos: make, default config (out-of-box)" # ~10s
1197 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001198}
1199
Gilles Peskine8f073122018-11-27 15:58:47 +01001200component_test_default_cmake_gcc_asan () {
1201 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001202 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1203 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001204
Gilles Peskine8f073122018-11-27 15:58:47 +01001205 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1206 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001207
Gilles Peskine82b27272019-06-14 18:27:03 +02001208 msg "program demos (ASan build)" # ~10s
1209 tests/scripts/run_demos.py
1210
Gilles Peskine97bea012020-04-23 23:37:45 +02001211 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001212 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001213
Gilles Peskine6848d172023-11-02 19:58:03 +01001214 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001215 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001216
Gilles Peskine8f073122018-11-27 15:58:47 +01001217 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001218 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001219
Gilles Peskine8f073122018-11-27 15:58:47 +01001220 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001221 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001222
1223 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001224 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001225}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001226
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001227component_test_default_cmake_gcc_asan_new_bignum () {
1228 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001229 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001230 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001231 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001232
1233 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1234 make test
1235
1236 msg "test: selftest (ASan build)" # ~ 10s
1237 programs/test/selftest
1238
1239 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1240 tests/ssl-opt.sh
1241
1242 msg "test: compat.sh (ASan build)" # ~ 6 min
1243 tests/compat.sh
1244
1245 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1246 tests/context-info.sh
1247}
1248
Hanno Becker01635512019-02-26 14:27:09 +00001249component_test_full_cmake_gcc_asan () {
1250 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001251 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001252 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1253 make
1254
1255 msg "test: main suites (inc. selftests) (full config, ASan build)"
1256 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001257
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001258 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001259 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001260
Gilles Peskine636c26a2020-03-04 20:46:15 +01001261 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001262 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001263
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001264 # Note: the next two invocations cover all compat.sh test cases.
1265 # We should use the same here and in basic-build-test.sh.
1266 msg "test: compat.sh: default version (full config, ASan build)"
1267 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001268
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001269 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1270 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001271
1272 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001273 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001274}
1275
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001276
1277component_test_full_cmake_gcc_asan_new_bignum () {
1278 msg "build: full config, cmake, gcc, ASan"
1279 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001280 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001281 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001282 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001283
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001284 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001285 make test
1286
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001287 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001288 programs/test/selftest
1289
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001290 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001291 tests/ssl-opt.sh
1292
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001293 # Note: the next two invocations cover all compat.sh test cases.
1294 # We should use the same here and in basic-build-test.sh.
1295 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1296 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001297
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001298 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1299 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001300
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001301 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001302 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001303}
1304
Ronald Cronc3623db2020-10-29 10:51:32 +01001305component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001306 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001307 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001308 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1309 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1310 make
1311
1312 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1313 make test
1314}
1315
David Horstmann4a48bec2024-03-13 15:42:31 +00001316component_test_psa_assume_exclusive_buffers () {
1317 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001318 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001319 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001320 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1321 make
1322
David Horstmann4a48bec2024-03-13 15:42:31 +00001323 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001324 make test
1325}
1326
Gilles Peskinea3548672021-06-17 11:37:52 +02001327# check_renamed_symbols HEADER LIB
1328# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1329# name is LIB.
1330check_renamed_symbols () {
1331 ! nm "$2" | sed 's/.* //' |
1332 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1333}
1334
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001335component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001336 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001337 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001338 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1339 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1340 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1341 # We can only compile, not link, since our test and sample programs
1342 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1343 # is active.
1344 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001345
1346 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1347 # version is not present.
1348 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001349 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001350}
1351
Valerio Setti63097752024-03-12 13:18:13 +01001352# Get a list of library-wise undefined symbols and ensure that they only
1353# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1354# This function is a common helper used by both:
1355# - component_test_default_psa_crypto_client_without_crypto_provider
1356# - component_build_full_psa_crypto_client_without_crypto_provider.
1357common_check_mbedtls_missing_symbols() {
1358 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1359 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1360 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1361 not grep mbedtls_ linking_errors.txt
1362
1363 rm sym_def.txt sym_undef.txt linking_errors.txt
1364}
1365
1366component_test_default_psa_crypto_client_without_crypto_provider () {
1367 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1368
Ronald Cron336678b2021-01-28 17:54:24 +01001369 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1370 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001371 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001372 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001373 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001374 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001375
Ronald Cron336678b2021-01-28 17:54:24 +01001376 make
1377
Valerio Setti63097752024-03-12 13:18:13 +01001378 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1379 common_check_mbedtls_missing_symbols
1380
1381 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001382 make test
1383}
1384
Valerio Setti63097752024-03-12 13:18:13 +01001385component_build_full_psa_crypto_client_without_crypto_provider () {
1386 msg "build: full config - PSA_CRYPTO_C"
1387
1388 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1389 scripts/config.py full
1390
1391 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1392 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1393 # Dynamic secure element support is a deprecated feature and it is not
1394 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1395 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1396
1397 # Since there is no crypto provider in this build it is not possible to
1398 # build all the test executables and progrems due to missing PSA functions
1399 # at link time. Therefore we will just build libraries and we'll check
1400 # that symbols of interest are there.
1401 make lib
1402
1403 msg "check missing symbols: full config - PSA_CRYPTO_C"
1404
1405 common_check_mbedtls_missing_symbols
1406
1407 # Ensure that desired functions are included into the build (extend the
1408 # following list as required).
1409 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1410 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1411 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1412}
1413
Ryan Everettdaa322a2024-04-18 16:48:55 +01001414component_test_no_rsa_key_pair_generation() {
1415 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001416 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001417 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001418 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001419 make
1420
Ryan Everettdaa322a2024-04-18 16:48:55 +01001421 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001422 make test
1423}
1424
Gilles Peskine782f4112018-11-27 16:11:09 +01001425component_test_ref_configs () {
1426 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001427 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1428 # want to re-generate generated files that depend on it, quite correctly.
1429 # However this doesn't work as the generation script expects a specific
1430 # format for mbedtls_config.h, which the other files don't follow. Also,
1431 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001432 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001433 # whether they're on or off. So, disable cmake's (over-sensitive here)
1434 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001435 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001436 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001437 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001438}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001439
Gilles Peskine8f073122018-11-27 15:58:47 +01001440component_test_no_renegotiation () {
1441 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001442 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001443 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001444 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001445
Gilles Peskine8f073122018-11-27 15:58:47 +01001446 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1447 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001448
Gilles Peskine8f073122018-11-27 15:58:47 +01001449 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001450 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001451}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001452
Gilles Peskine636c26a2020-03-04 20:46:15 +01001453component_test_no_pem_no_fs () {
1454 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1455 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1456 scripts/config.py unset MBEDTLS_FS_IO
1457 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1458 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001459 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001460 make
1461
1462 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1463 make test
1464
1465 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001466 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001467}
1468
Gilles Peskine8f073122018-11-27 15:58:47 +01001469component_test_rsa_no_crt () {
1470 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001471 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001472 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001473 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001474
Gilles Peskine8f073122018-11-27 15:58:47 +01001475 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1476 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001477
Gilles Peskine8f073122018-11-27 15:58:47 +01001478 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001479 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001480
Gilles Peskine8f073122018-11-27 15:58:47 +01001481 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001482 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001483
1484 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001485 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001486}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001487
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001488component_test_no_ctr_drbg_classic () {
1489 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001490 scripts/config.py full
1491 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001492 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001493 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001494
Dave Rodgman17127e92023-12-14 16:42:48 +00001495 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001496 make
1497
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001498 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001499 make test
1500
Gilles Peskineba749042021-01-13 20:02:03 +01001501 # In this configuration, the TLS test programs use HMAC_DRBG.
1502 # The SSL tests are slow, so run a small subset, just enough to get
1503 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001504 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001505 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001506
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001508 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001509}
1510
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001511component_test_no_ctr_drbg_use_psa () {
1512 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001513 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001514 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1515 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001516
Dave Rodgman17127e92023-12-14 16:42:48 +00001517 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001518 make
1519
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001520 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1521 make test
1522
1523 # In this configuration, the TLS test programs use HMAC_DRBG.
1524 # The SSL tests are slow, so run a small subset, just enough to get
1525 # confidence that the SSL code copes with HMAC_DRBG.
1526 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001527 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001528
1529 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001530 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001531}
1532
1533component_test_no_hmac_drbg_classic () {
1534 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1535 scripts/config.py full
1536 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1537 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1538 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001539 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540
Dave Rodgman17127e92023-12-14 16:42:48 +00001541 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001542 make
1543
1544 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001545 make test
1546
Gilles Peskinea2224342020-11-19 22:14:34 +01001547 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1548 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1549 # instead.
1550 # Test SSL with non-deterministic ECDSA. Only test features that
1551 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001552 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001553 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001554
1555 # To save time, only test one protocol version, since this part of
1556 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001557 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001558 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001559}
1560
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001561component_test_no_hmac_drbg_use_psa () {
1562 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1563 scripts/config.py full
1564 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1565 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1566 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1567
Dave Rodgman17127e92023-12-14 16:42:48 +00001568 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001569 make
1570
1571 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1572 make test
1573
1574 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1575 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1576 # instead.
1577 # Test SSL with non-deterministic ECDSA. Only test features that
1578 # might be affected by how ECDSA signature is performed.
1579 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001580 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001581
1582 # To save time, only test one protocol version, since this part of
1583 # the protocol is identical in (D)TLS up to 1.2.
1584 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001585 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001586}
1587
1588component_test_psa_external_rng_no_drbg_classic () {
1589 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1590 scripts/config.py full
1591 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001592 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001593 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001594 scripts/config.py unset MBEDTLS_ENTROPY_C
1595 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1596 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001597 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1598 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1599 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001600 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1601 # the SSL test programs don't have an RNG and can't work. Explicitly
1602 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001603 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001604
1605 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1606 make test
1607
Gilles Peskine8eb29432021-02-03 20:07:11 +01001608 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001609 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001610}
1611
1612component_test_psa_external_rng_no_drbg_use_psa () {
1613 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001614 scripts/config.py full
1615 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001616 scripts/config.py unset MBEDTLS_ENTROPY_C
1617 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1618 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001619 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1620 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1621 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001622 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001623
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001624 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001625 make test
1626
Gilles Peskine8eb29432021-02-03 20:07:11 +01001627 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001628 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001629}
1630
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001631component_test_psa_external_rng_use_psa_crypto () {
1632 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1633 scripts/config.py full
1634 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1635 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1636 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001637 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001638
1639 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1640 make test
1641
1642 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1643 tests/ssl-opt.sh -f 'Default\|opaque'
1644}
1645
Gilles Peskine801c4332023-04-28 21:04:28 +02001646component_test_psa_inject_entropy () {
1647 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1648 scripts/config.py full
1649 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1650 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1651 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1652 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1653 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1654 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001655 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine801c4332023-04-28 21:04:28 +02001656
1657 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1658 make test
1659}
1660
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001661component_test_sw_inet_pton () {
1662 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1663
1664 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1665 scripts/config.py set MBEDTLS_TEST_HOOKS
1666 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1667
1668 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1669 make test
1670}
1671
Valerio Settia41654d2024-02-08 10:33:11 +01001672component_full_no_pkparse_pkwrite() {
1673 msg "build: full without pkparse and pkwrite"
1674
1675 scripts/config.py crypto_full
1676 scripts/config.py unset MBEDTLS_PK_PARSE_C
1677 scripts/config.py unset MBEDTLS_PK_WRITE_C
1678
Valerio Settia41654d2024-02-08 10:33:11 +01001679 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1680
1681 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1682 not grep mbedtls_pk_parse_key library/pkparse.o
1683 not grep mbedtls_pk_write_key_der library/pkwrite.o
1684
1685 msg "test: full without pkparse and pkwrite"
1686 make test
1687}
1688
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001689component_test_crypto_full_md_light_only () {
1690 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001691 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001692 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001693 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001694 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001695 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001696 scripts/config.py unset MBEDTLS_HKDF_C
1697 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001698 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001699 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001700 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001701 # Disable things that would auto-enable MD_C
1702 scripts/config.py unset MBEDTLS_PKCS5_C
1703
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001704 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1705 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001706 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001707
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001708 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001709 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001710 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001711
1712 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001713 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001714}
1715
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001716component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001717 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001718 scripts/config.py full
1719 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001720 # Don't pull in cipher via PSA mechanisms
1721 # (currently ignored anyway because we completely disable PSA)
1722 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001723 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001724 scripts/config.py unset MBEDTLS_CMAC_C
1725 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001726 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001727 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001728 scripts/config.py unset MBEDTLS_SSL_TLS_C
1729 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001730 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001731 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1732 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001733 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001734 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001735 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001736
Valerio Settidf17a102023-10-23 14:14:19 +02001737 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001738 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001739}
1740
Valerio Setti7e710e82023-08-25 09:14:15 +02001741# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001742# - component_test_full_no_cipher_with_psa_crypto
1743# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001744# It accepts 2 input parameters:
1745# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1746# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001747common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001748 USE_CRYPTO_CONFIG="$1"
1749 COMPONENT_DESCRIPTION="$2"
1750
1751 msg "build: $COMPONENT_DESCRIPTION"
1752
1753 scripts/config.py full
1754 scripts/config.py unset MBEDTLS_CIPHER_C
1755
1756 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001757 # The built-in implementation of the following algs/key-types depends
1758 # on CIPHER_C so we disable them.
1759 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1760 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001761 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001762 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1763 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1764 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1765 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1766 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1767 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1768 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Crona33a8242024-05-15 18:31:17 +02001769 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001770 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001771 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001772 else
1773 # Don't pull in cipher via PSA mechanisms
1774 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001775 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1776 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1777 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001778 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001779 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001780 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001781 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001782
Gilles Peskine21570cf2023-12-22 11:49:50 +01001783 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001784
Valerio Setti7e710e82023-08-25 09:14:15 +02001785 # Ensure that CIPHER_C was not re-enabled
1786 not grep mbedtls_cipher_init library/cipher.o
1787
1788 msg "test: $COMPONENT_DESCRIPTION"
1789 make test
1790}
1791
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001792component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001793 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001794}
1795
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001796component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001797 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001798}
1799
Valerio Settibdfecb62023-11-07 15:37:20 +01001800component_test_full_no_ccm() {
1801 msg "build: full no PSA_WANT_ALG_CCM"
1802
1803 # Full config enables:
1804 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1805 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1806 scripts/config.py full
1807
1808 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1809 # enabled, but not used from TLS since USE_PSA is set.
1810 # This is helpful to ensure that TLS tests below have proper dependencies.
1811 #
1812 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1813 # PSA_WANT_ALG_CCM to be re-enabled.
1814 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1815
Gilles Peskine21570cf2023-12-22 11:49:50 +01001816 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001817
1818 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001819 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001820}
1821
1822component_test_full_no_ccm_star_no_tag() {
1823 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1824
1825 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1826 scripts/config.py full
1827
1828 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1829 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1830 # This basically disables all unauthenticated ciphers on the PSA side, while
1831 # keeping AEADs enabled.
1832 #
1833 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1834 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1835 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1836 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1840 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1841 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1842 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1843
Gilles Peskine21570cf2023-12-22 11:49:50 +01001844 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001845
1846 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001847 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001848
1849 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001850 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001851}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001852
Valerio Settie1655b82023-01-03 15:35:25 +01001853component_test_full_no_bignum () {
1854 msg "build: full minus bignum"
1855 scripts/config.py full
1856 scripts/config.py unset MBEDTLS_BIGNUM_C
1857 # Direct dependencies of bignum
1858 scripts/config.py unset MBEDTLS_ECP_C
1859 scripts/config.py unset MBEDTLS_RSA_C
1860 scripts/config.py unset MBEDTLS_DHM_C
1861 # Direct dependencies of ECP
1862 scripts/config.py unset MBEDTLS_ECDH_C
1863 scripts/config.py unset MBEDTLS_ECDSA_C
1864 scripts/config.py unset MBEDTLS_ECJPAKE_C
1865 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001866 # Disable what auto-enables ECP_LIGHT
1867 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1868 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001869 # Indirect dependencies of ECP
1870 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1871 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1872 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1873 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1874 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1875 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1876 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1877 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1878 # Direct dependencies of DHM
1879 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1880 # Direct dependencies of RSA
1881 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1882 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1883 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1884 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1885 # PK and its dependencies
1886 scripts/config.py unset MBEDTLS_PK_C
1887 scripts/config.py unset MBEDTLS_PK_PARSE_C
1888 scripts/config.py unset MBEDTLS_PK_WRITE_C
1889 scripts/config.py unset MBEDTLS_X509_USE_C
1890 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1891 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1892 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1893 scripts/config.py unset MBEDTLS_X509_CREATE_C
1894 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1895 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1896 scripts/config.py unset MBEDTLS_PKCS7_C
1897 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1898 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1899 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1900
Gilles Peskine21570cf2023-12-22 11:49:50 +01001901 make
Valerio Settie1655b82023-01-03 15:35:25 +01001902
1903 msg "test: full minus bignum"
1904 make test
1905}
1906
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001907component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001908 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001909
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001910 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001911 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001912 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001913 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001914 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001915 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1916 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001917 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001918 scripts/config.py unset MBEDTLS_GCM_C
1919 scripts/config.py unset MBEDTLS_CCM_C
1920 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001921 #Disable TLS 1.3 (as no AEAD)
1922 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001923 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1924 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1925 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001926 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney67338c02024-05-09 15:21:14 +01001927 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001928 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001929 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001930 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001931 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1932 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001933 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001934 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001935 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001936
Przemek Stekiel9550c052022-09-28 09:51:55 +02001937 make
1938
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001939 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001940 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001941
1942 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001943}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001944
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001945component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001946 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001947
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001948 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001949 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001950 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001951 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001952 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001953 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1954 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001955 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001956 scripts/config.py unset MBEDTLS_GCM_C
1957 scripts/config.py unset MBEDTLS_CCM_C
1958 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001959 #Disable TLS 1.3 (as no AEAD)
1960 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001961 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney62586212024-04-26 17:01:16 +01001962 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001963 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001964 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001965 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001966 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001967 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001968 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001969 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001970
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001971 make
1972
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001973 msg "test: default with only CBC-legacy cipher use psa"
1974 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001975
1976 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1977 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001978}
1979
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001980component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001981 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001982
1983 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001984 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001985 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001986 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001987 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001988 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1989 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001990 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001991 scripts/config.py unset MBEDTLS_GCM_C
1992 scripts/config.py unset MBEDTLS_CCM_C
1993 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001994 #Disable TLS 1.3 (as no AEAD)
1995 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001996 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001997 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001998 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1999 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2000 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002001 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002002 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002003 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002004 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002005
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002006 make
2007
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002008 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002009 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002010
2011 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2012 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002013}
2014
Valerio Setti9f0ec532022-11-08 13:03:24 +01002015# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2016# that we could use for interop testing. However, we now have sort of two
2017# implementations ourselves: one using PSA, the other not. At least test that
2018# these two interoperate with each other.
2019component_test_tls1_2_ecjpake_compatibility() {
2020 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2021 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002022 # Explicitly make lib first to avoid a race condition:
2023 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2024 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002025 make -C programs ssl/ssl_server2 ssl/ssl_client2
2026 cp programs/ssl/ssl_server2 s2_no_use_psa
2027 cp programs/ssl/ssl_client2 c2_no_use_psa
2028
2029 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2030 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2031 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002032 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002033 make -C programs ssl/ssl_server2 ssl/ssl_client2
2034 make -C programs test/udp_proxy test/query_compile_time_config
2035
Valerio Setti70e02902022-12-02 16:21:56 +01002036 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2037 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2038 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2039 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2040 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2041 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2042 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2043 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 +01002044
2045 rm s2_no_use_psa c2_no_use_psa
2046}
2047
Gilles Peskine636c26a2020-03-04 20:46:15 +01002048component_test_everest () {
2049 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2050 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2051 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2052 make
2053
2054 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2055 make test
2056
Gilles Peskine6848d172023-11-02 19:58:03 +01002057 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002058 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002059
Gilles Peskine636c26a2020-03-04 20:46:15 +01002060 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2061 tests/ssl-opt.sh -f ECDH
2062
2063 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2064 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002065 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002066}
2067
Gilles Peskined3beca92020-07-03 00:15:37 +02002068component_test_everest_curve25519_only () {
2069 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002070 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02002071 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2072 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002073 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
2074 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
2075 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02002076 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2077 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002078 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002079 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
2080
Gilles Peskined3beca92020-07-03 00:15:37 +02002081 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002082 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002083 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
2084 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02002085
Dave Rodgman17127e92023-12-14 16:42:48 +00002086 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002087
2088 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2089 make test
2090}
2091
Gilles Peskine8f073122018-11-27 15:58:47 +01002092component_test_small_ssl_out_content_len () {
2093 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002094 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2095 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002096 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002097 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002098
Gilles Peskine8f073122018-11-27 15:58:47 +01002099 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002100 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002101}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002102
Gilles Peskine8f073122018-11-27 15:58:47 +01002103component_test_small_ssl_in_content_len () {
2104 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002105 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2106 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002107 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002108 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002109
Gilles Peskine8f073122018-11-27 15:58:47 +01002110 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002111 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002112}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002113
Gilles Peskine8f073122018-11-27 15:58:47 +01002114component_test_small_ssl_dtls_max_buffering () {
2115 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002116 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002117 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002118 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002119
Gilles Peskine8f073122018-11-27 15:58:47 +01002120 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002121 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 +01002122}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002123
Gilles Peskine8f073122018-11-27 15:58:47 +01002124component_test_small_mbedtls_ssl_dtls_max_buffering () {
2125 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002126 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002127 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002128 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002129
Gilles Peskine8f073122018-11-27 15:58:47 +01002130 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002131 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002132}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002133
Gilles Peskine75cc7712019-09-06 19:47:17 +02002134component_test_psa_collect_statuses () {
2135 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002136 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002137 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002138 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002139 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002140 rm -f tests/statuses.log
2141}
2142
Gilles Peskine8f073122018-11-27 15:58:47 +01002143component_test_full_cmake_clang () {
2144 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002145 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002146 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 +01002147 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002148
k-stachowiak0291cb72019-06-26 15:52:12 +02002149 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002150 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002151
Gilles Peskineda6017c2022-10-30 21:02:40 +01002152 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2153 programs/test/cpp_dummy_build
2154
Gilles Peskine6848d172023-11-02 19:58:03 +01002155 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002156 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002157
Gilles Peskine82b27272019-06-14 18:27:03 +02002158 msg "program demos (full config, clang)" # ~10s
2159 tests/scripts/run_demos.py
2160
k-stachowiak0291cb72019-06-26 15:52:12 +02002161 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002162 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002163
Gilles Peskine8f073122018-11-27 15:58:47 +01002164 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002165 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002166}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002167
Gilles Peskine0c671602022-11-29 16:01:41 +01002168skip_suites_without_constant_flow () {
2169 # Skip the test suites that don't have any constant-flow annotations.
2170 # This will need to be adjusted if we ever start declaring things as
2171 # secret from macros or functions inside tests/include or tests/src.
2172 SKIP_TEST_SUITES=$(
2173 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2174 sed 's/test_suite_//; s/\.function$//' |
2175 tr '\n' ,)
2176 export SKIP_TEST_SUITES
2177}
2178
Dave Rodgman246210e2023-07-31 18:07:44 +01002179skip_all_except_given_suite () {
2180 # Skip all but the given test suite
2181 SKIP_TEST_SUITES=$(
2182 ls -1 tests/suites/test_suite_*.function |
2183 grep -v $1.function |
2184 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2185 tr '\n' ,)
2186 export SKIP_TEST_SUITES
2187}
2188
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002189component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002190 # This tests both (1) accesses to undefined memory, and (2) branches or
2191 # memory access depending on secret values. To distinguish between those:
2192 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2193 # - or alternatively, change the build type to MemSanDbg, which enables
2194 # origin tracking and nicer stack traces (which are useful for debugging
2195 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002196 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2197 scripts/config.py full
2198 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2199 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2200 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2201 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2202 make
2203
2204 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2205 make test
2206}
2207
2208component_test_memsan_constant_flow_psa () {
2209 # This tests both (1) accesses to undefined memory, and (2) branches or
2210 # memory access depending on secret values. To distinguish between those:
2211 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2212 # - or alternatively, change the build type to MemSanDbg, which enables
2213 # origin tracking and nicer stack traces (which are useful for debugging
2214 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002215 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002216 scripts/config.py full
2217 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2218 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2219 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2220 make
2221
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002222 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002223 make test
2224}
2225
Bence Szépkúti0354d042023-12-06 16:14:37 +01002226component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002227 # This tests both (1) everything that valgrind's memcheck usually checks
2228 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2229 # etc.) and (2) branches or memory access depending on secret values,
2230 # which will be reported as uninitialized memory. To distinguish between
2231 # secret and actually uninitialized:
2232 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2233 # - or alternatively, build with debug info and manually run the offending
2234 # test suite with valgrind --track-origins=yes, then check if the origin
2235 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002236 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2237 scripts/config.py full
2238 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2239 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002240 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002241 cmake -D CMAKE_BUILD_TYPE:String=Release .
2242 make
2243
2244 # this only shows a summary of the results (how many of each type)
2245 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002246 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002247 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002248
2249 # Test asm path in constant time module - by default, it will test the plain C
2250 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2251 msg "test: valgrind asm constant_time"
2252 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2253 skip_all_except_given_suite test_suite_constant_time
2254 cmake -D CMAKE_BUILD_TYPE:String=Release .
2255 make clean
2256 make
2257 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002258}
2259
Bence Szépkúti0354d042023-12-06 16:14:37 +01002260component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002261 # This tests both (1) everything that valgrind's memcheck usually checks
2262 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2263 # etc.) and (2) branches or memory access depending on secret values,
2264 # which will be reported as uninitialized memory. To distinguish between
2265 # secret and actually uninitialized:
2266 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2267 # - or alternatively, build with debug info and manually run the offending
2268 # test suite with valgrind --track-origins=yes, then check if the origin
2269 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002270 msg "build: cmake release GCC, full config with constant flow testing"
2271 scripts/config.py full
2272 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002273 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002274 cmake -D CMAKE_BUILD_TYPE:String=Release .
2275 make
2276
2277 # this only shows a summary of the results (how many of each type)
2278 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002279 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002280 make memcheck
2281}
2282
Janos Follath9338cac2023-10-04 18:55:39 +01002283component_test_tsan () {
2284 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002285 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002286 scripts/config.py set MBEDTLS_THREADING_C
2287 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002288 # Self-tests do not currently use multiple threads.
2289 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002290
Ryan6caf84f2024-03-05 13:57:00 +00002291 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2292 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2293
Janos Follath9338cac2023-10-04 18:55:39 +01002294 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2295 make
2296
2297 msg "test: main suites (TSan)"
2298 make test
2299}
2300
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002301component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002302 # Test that removing the deprecated features from the default
2303 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002304 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2305 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002306 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002307
2308 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2309 make test
2310}
2311
2312component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002313 msg "build: make, full_no_deprecated config" # ~ 30s
2314 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002315 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002316
Gilles Peskine30de2e82020-04-20 21:39:22 +02002317 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002318 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002319
2320 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2321 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002322}
2323
Gilles Peskine8386ea22020-04-30 09:07:29 +02002324component_test_full_no_deprecated_deprecated_warning () {
2325 # Test that there is nothing deprecated in "full_no_deprecated".
2326 # A deprecated feature would trigger a warning (made fatal) from
2327 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002328 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2329 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002330 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2331 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002332 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002333
Gilles Peskine30de2e82020-04-20 21:39:22 +02002334 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002335 make test
2336}
2337
Gilles Peskine8386ea22020-04-30 09:07:29 +02002338component_test_full_deprecated_warning () {
2339 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2340 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002341 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002342 scripts/config.py full
2343 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002344 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002345 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2346 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002347 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002348
Gilles Peskine8386ea22020-04-30 09:07:29 +02002349 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2350 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2351 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002352 # Expect warnings from '#warning' directives in check_config.h and
2353 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002354 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 +01002355
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002356 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2357 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002358
2359 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2360 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002361}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002362
Gilles Peskineec541fe2020-01-31 14:24:14 +01002363# Check that the specified libraries exist and are empty.
2364are_empty_libraries () {
2365 nm "$@" >/dev/null 2>/dev/null
2366 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2367}
2368
2369component_build_crypto_default () {
2370 msg "build: make, crypto only"
2371 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002372 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002373 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002374}
2375
2376component_build_crypto_full () {
2377 msg "build: make, crypto only, full config"
2378 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002379 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002380 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002381}
2382
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002383component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002384 msg "build: make, config for PSA crypto service"
2385 scripts/config.py crypto
2386 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2387 # Disable things that are not needed for just cryptography, to
2388 # reach a configuration that would be typical for a PSA cryptography
2389 # service providing all implemented PSA algorithms.
2390 # System stuff
2391 scripts/config.py unset MBEDTLS_ERROR_C
2392 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002393 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002394 # Crypto stuff with no PSA interface
2395 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002396 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002397 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002398 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002399 scripts/config.py unset MBEDTLS_NIST_KW_C
2400 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2401 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2402 scripts/config.py unset MBEDTLS_PKCS12_C
2403 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002404 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2405 # in PSA code to work with RSA keys. We don't require users to set those:
2406 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002407 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002408 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002409 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002410 make CFLAGS='-O1 -Werror' all test
2411 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2412}
2413
Gilles Peskineec541fe2020-01-31 14:24:14 +01002414component_build_crypto_baremetal () {
2415 msg "build: make, crypto only, baremetal config"
2416 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002417 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002418 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002419}
Daniel Axtens446af202020-09-02 21:30:13 +10002420support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002421 support_build_baremetal "$@"
2422}
2423
2424component_build_baremetal () {
2425 msg "build: make, baremetal config"
2426 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002427 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002428}
2429support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002430 # Older Glibc versions include time.h from other headers such as stdlib.h,
2431 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2432 # problem, Ubuntu 18.04 is ok.
2433 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2434}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002435
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002436# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002437component_test_depends_py_cipher_id () {
2438 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002439 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002440}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002441
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002442component_test_depends_py_cipher_chaining () {
2443 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002444 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002445}
2446
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002447component_test_depends_py_cipher_padding () {
2448 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002449 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002450}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002451
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002452component_test_depends_py_curves () {
2453 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002454 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002455}
2456
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002457component_test_depends_py_hashes () {
2458 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002459 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002460}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002461
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002462component_test_depends_py_kex () {
2463 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002464 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002465}
2466
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002467component_test_depends_py_pkalgs () {
2468 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002469 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002470}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002471
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002472# PSA equivalents of the depends.py tests
2473component_test_depends_py_cipher_id_psa () {
2474 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002475 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002476}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002477
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002478component_test_depends_py_cipher_chaining_psa () {
2479 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002480 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002481}
2482
2483component_test_depends_py_cipher_padding_psa () {
2484 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002485 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002486}
2487
2488component_test_depends_py_curves_psa () {
2489 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002490 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002491}
2492
2493component_test_depends_py_hashes_psa () {
2494 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002495 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002496}
2497
2498component_test_depends_py_kex_psa () {
2499 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002500 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002501}
2502
2503component_test_depends_py_pkalgs_psa () {
2504 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002505 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002506}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002507
Valerio Setti6bed64e2024-01-17 15:21:44 +01002508component_test_psa_crypto_config_ffdh_2048_only () {
2509 msg "build: full config - only DH 2048"
2510
2511 scripts/config.py full
2512
2513 # Disable all DH groups other than 2048.
2514 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2515 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2516 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2517 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2518
2519 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2520
2521 msg "test: full config - only DH 2048"
2522 make test
2523
2524 msg "ssl-opt: full config - only DH 2048"
2525 tests/ssl-opt.sh -f "ffdh"
2526}
2527
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002528component_build_no_pk_rsa_alt_support () {
2529 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2530
2531 scripts/config.py full
2532 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2533 scripts/config.py set MBEDTLS_RSA_C
2534 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2535
2536 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002537 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002538}
2539
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002540component_build_module_alt () {
2541 msg "build: MBEDTLS_XXX_ALT" # ~30s
2542 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002543
2544 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002545 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2546 scripts/config.py unset MBEDTLS_AESNI_C
2547 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002548 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002549 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2550 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002551 # You can only have one threading implementation: alt or pthread, not both.
2552 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002553 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2554 # directly and assumes the implementation works with partial groups.
2555 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002556 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2557 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2558 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002559 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2560 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2561 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002562
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002563 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2564 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2565 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002566 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002567
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002568 # We can only compile, not link, since we don't have any implementations
2569 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002570 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002571}
2572
2573component_build_dhm_alt () {
2574 msg "build: MBEDTLS_DHM_ALT" # ~30s
2575 scripts/config.py full
2576 scripts/config.py set MBEDTLS_DHM_ALT
2577 # debug.c currently references mbedtls_dhm_context fields directly.
2578 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002579 # We can only compile, not link, since we don't have any implementations
2580 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002581 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002582}
2583
Gilles Peskine64996c32024-01-23 20:25:47 +01002584component_test_no_psa_crypto_full_cmake_asan() {
2585 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2586 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002587 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002588 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002589 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002590 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002591 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002592 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002593 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002594 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002595 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002596 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002597 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002598 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002599
Gilles Peskine64996c32024-01-23 20:25:47 +01002600 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002601 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002602
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002603 # Note: ssl-opt.sh has some test cases that depend on
2604 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2605 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002606 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002607 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002608
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002609 # Note: the next two invocations cover all compat.sh test cases.
2610 # We should use the same here and in basic-build-test.sh.
2611 msg "test: compat.sh: default version (full minus PSA crypto)"
2612 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002613
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002614 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002615 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002616}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002617
Ronald Cron403c15c2021-09-13 09:38:05 +02002618component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002619 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002620
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002621 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002622 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002623 $(helper_get_psa_key_type_list "ECC") \
2624 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002625
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002626 # Configure
2627 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002628
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002629 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002630 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002631
2632 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002633 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002634
2635 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002636 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2637 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2638
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002639 # Build
2640 # -----
2641
2642 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002643 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2644 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002645
2646 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2647
Valerio Setti3fe105b2023-10-30 11:08:12 +01002648 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002649
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002650 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002651 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002652
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002653 # Run the tests
2654 # -------------
2655
Ronald Cron403c15c2021-09-13 09:38:05 +02002656 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2657 make test
2658}
2659
Valerio Setti44b178c2023-03-22 14:02:57 +01002660component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002661 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002662
2663 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002664 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002665 $(helper_get_psa_key_type_list "ECC") \
2666 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002667
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002668 # Configure
2669 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002670
Ronald Cron46ac0652024-03-18 12:39:04 +01002671 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002672 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002673
Valerio Setti44b178c2023-03-22 14:02:57 +01002674 # Disable the module that's accelerated
2675 scripts/config.py unset MBEDTLS_ECDH_C
2676
2677 # Disable things that depend on it
2678 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2679 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2680 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2682 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2683
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002684 # Build
2685 # -----
2686
2687 helper_libtestdriver1_make_drivers "$loc_accel_list"
2688
Valerio Setti3fe105b2023-10-30 11:08:12 +01002689 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002690
Valerio Setti44b178c2023-03-22 14:02:57 +01002691 # Make sure this was not re-enabled by accident (additive config)
2692 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002693
2694 # Run the tests
2695 # -------------
2696
Valerio Setti44b178c2023-03-22 14:02:57 +01002697 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002698 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002699}
2700
Przemek Stekieldccb2022023-05-11 10:48:50 +02002701component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002702 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002703
2704 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002705 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002706 $(helper_get_psa_key_type_list "DH") \
2707 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002708
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002709 # Configure
2710 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002711
Przemek Stekiel565353e2023-07-05 11:07:07 +02002712 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002713 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002714
2715 # Disable the module that's accelerated
2716 scripts/config.py unset MBEDTLS_DHM_C
2717
2718 # Disable things that depend on it
2719 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2720 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2721
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002722 # Build
2723 # -----
2724
2725 helper_libtestdriver1_make_drivers "$loc_accel_list"
2726
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002727 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002728
2729 # Make sure this was not re-enabled by accident (additive config)
2730 not grep mbedtls_dhm_ library/dhm.o
2731
2732 # Run the tests
2733 # -------------
2734
Gilles Peskine14302ed2023-07-19 19:30:04 +02002735 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002736 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002737
Gilles Peskine14302ed2023-07-19 19:30:04 +02002738 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002739 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002740}
2741
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002742component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002743 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002744
2745 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002746 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002747
2748 # Disable things that are not supported
2749 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2750 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002751 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002752
Gilles Peskine14302ed2023-07-19 19:30:04 +02002753 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002754 make test
2755
Gilles Peskine14302ed2023-07-19 19:30:04 +02002756 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002757 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002758}
2759
Valerio Setti44b178c2023-03-22 14:02:57 +01002760component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002761 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002762
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002763 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002764 $(helper_get_psa_key_type_list "ECC") \
2765 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002766
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002767 # Configure
2768 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002769
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002770 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002771
2772 # Make built-in fallback not available
2773 scripts/config.py unset MBEDTLS_ECJPAKE_C
2774 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2775
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002776 # Build
2777 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002778
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002779 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002780
Valerio Setti3fe105b2023-10-30 11:08:12 +01002781 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002782
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002783 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002784 not grep mbedtls_ecjpake_init library/ecjpake.o
2785
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002786 # Run the tests
2787 # -------------
2788
Gilles Peskine14302ed2023-07-19 19:30:04 +02002789 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002790 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002791}
2792
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002793component_test_psa_crypto_config_accel_ecc_some_key_types () {
2794 msg "build: full with accelerated EC algs and some key types"
2795
2796 # Algorithms and key types to accelerate
2797 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2798 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2799 ALG_ECDH \
2800 ALG_JPAKE \
2801 KEY_TYPE_ECC_PUBLIC_KEY \
2802 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2803 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002804 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2805 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002806
2807 # Configure
2808 # ---------
2809
2810 # start with config full for maximum coverage (also enables USE_PSA)
2811 helper_libtestdriver1_adjust_config "full"
2812
2813 # Disable modules that are accelerated - some will be re-enabled
2814 scripts/config.py unset MBEDTLS_ECDSA_C
2815 scripts/config.py unset MBEDTLS_ECDH_C
2816 scripts/config.py unset MBEDTLS_ECJPAKE_C
2817 scripts/config.py unset MBEDTLS_ECP_C
2818
2819 # Disable all curves - those that aren't accelerated should be re-enabled
2820 helper_disable_builtin_curves
2821
2822 # Restartable feature is not yet supported by PSA. Once it will in
2823 # the future, the following line could be removed (see issues
2824 # 6061, 6332 and following ones)
2825 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2826
2827 # this is not supported by the driver API yet
2828 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2829
2830 # Build
2831 # -----
2832
2833 # These hashes are needed for some ECDSA signature tests.
2834 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2835 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2836 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2837
Valerio Setti3fe105b2023-10-30 11:08:12 +01002838 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002839
2840 # ECP should be re-enabled but not the others
2841 not grep mbedtls_ecdh_ library/ecdh.o
2842 not grep mbedtls_ecdsa library/ecdsa.o
2843 not grep mbedtls_ecjpake library/ecjpake.o
2844 grep mbedtls_ecp library/ecp.o
2845
2846 # Run the tests
2847 # -------------
2848
2849 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002850 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002851}
2852
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002853# Run tests with only (non-)Weierstrass accelerated
2854# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002855# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2856# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002857common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002858 weierstrass=$1
2859 if [ $weierstrass -eq 1 ]; then
2860 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002861 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002862 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002863 fi
2864
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002865 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002866
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002867 # Note: Curves are handled in a special way by the libtestdriver machinery,
2868 # so we only want to include them in the accel list when building the main
2869 # libraries, hence the use of a separate variable.
2870 # Note: the following loop is a modified version of
2871 # helper_get_psa_curve_list that only keeps Weierstrass families.
2872 loc_weierstrass_list=""
2873 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002874 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2875 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002876 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002877 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002878 ;;
2879 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002880 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002881 ;;
2882 esac
2883 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002884 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002885 loc_curve_list=$loc_weierstrass_list
2886 else
2887 loc_curve_list=$loc_non_weierstrass_list
2888 fi
2889
Valerio Setti3fe105b2023-10-30 11:08:12 +01002890 # Algorithms and key types to accelerate
2891 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2892 ALG_ECDH \
2893 ALG_JPAKE \
2894 $(helper_get_psa_key_type_list "ECC") \
2895 $loc_curve_list"
2896
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002897 # Configure
2898 # ---------
2899
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002900 # Start with config crypto_full and remove PK_C:
2901 # that's what's supported now, see docs/driver-only-builds.md.
2902 helper_libtestdriver1_adjust_config "crypto_full"
2903 scripts/config.py unset MBEDTLS_PK_C
2904 scripts/config.py unset MBEDTLS_PK_PARSE_C
2905 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002906
2907 # Disable modules that are accelerated - some will be re-enabled
2908 scripts/config.py unset MBEDTLS_ECDSA_C
2909 scripts/config.py unset MBEDTLS_ECDH_C
2910 scripts/config.py unset MBEDTLS_ECJPAKE_C
2911 scripts/config.py unset MBEDTLS_ECP_C
2912
2913 # Disable all curves - those that aren't accelerated should be re-enabled
2914 helper_disable_builtin_curves
2915
2916 # Restartable feature is not yet supported by PSA. Once it will in
2917 # the future, the following line could be removed (see issues
2918 # 6061, 6332 and following ones)
2919 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2920
2921 # this is not supported by the driver API yet
2922 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2923
2924 # Build
2925 # -----
2926
2927 # These hashes are needed for some ECDSA signature tests.
2928 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2929 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2930 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2931
Valerio Settiac7a8092023-10-31 12:23:44 +01002932 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002933
2934 # We expect ECDH to be re-enabled for the missing curves
2935 grep mbedtls_ecdh_ library/ecdh.o
2936 # We expect ECP to be re-enabled, however the parts specific to the
2937 # families of curves that are accelerated should be ommited.
2938 # - functions with mxz in the name are specific to Montgomery curves
2939 # - ecp_muladd is specific to Weierstrass curves
2940 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002941 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002942 not grep mbedtls_ecp_muladd library/ecp.o
2943 grep mxz library/ecp.o
2944 else
2945 grep mbedtls_ecp_muladd library/ecp.o
2946 not grep mxz library/ecp.o
2947 fi
2948 # We expect ECDSA and ECJPAKE to be re-enabled only when
2949 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002950 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002951 not grep mbedtls_ecdsa library/ecdsa.o
2952 not grep mbedtls_ecjpake library/ecjpake.o
2953 else
2954 grep mbedtls_ecdsa library/ecdsa.o
2955 grep mbedtls_ecjpake library/ecjpake.o
2956 fi
2957
2958 # Run the tests
2959 # -------------
2960
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002961 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2962 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002963}
2964
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002965component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002966 common_test_psa_crypto_config_accel_ecc_some_curves 1
2967}
2968
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002969component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002970 common_test_psa_crypto_config_accel_ecc_some_curves 0
2971}
2972
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002973# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2974# ECDH, ECDSA) with and without drivers.
2975# The input parameter is a boolean value which indicates:
2976# - 0 keep built-in EC algs,
2977# - 1 exclude built-in EC algs (driver only).
2978#
2979# This is used by the two following components to ensure they always use the
2980# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002981# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2982# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002983# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002984config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002985 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002986 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002987 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002988 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002989 # Disable modules that are accelerated
2990 scripts/config.py unset MBEDTLS_ECDSA_C
2991 scripts/config.py unset MBEDTLS_ECDH_C
2992 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002993 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002994 fi
2995
2996 # Restartable feature is not yet supported by PSA. Once it will in
2997 # the future, the following line could be removed (see issues
2998 # 6061, 6332 and following ones)
2999 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003000}
3001
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003002# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3003component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003004 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003005
3006 # Algorithms and key types to accelerate
3007 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3008 ALG_ECDH \
3009 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003010 $(helper_get_psa_key_type_list "ECC") \
3011 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003012
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003013 # Configure
3014 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003015
3016 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003017 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003018
Valerio Setti0a342c92023-09-01 09:12:31 +02003019 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003020 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3021 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003022
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003023 # Build
3024 # -----
3025
3026 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003027 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3028 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003029 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3030
Valerio Setti3fe105b2023-10-30 11:08:12 +01003031 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003032
3033 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3034 not grep mbedtls_ecdsa_ library/ecdsa.o
3035 not grep mbedtls_ecdh_ library/ecdh.o
3036 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003037 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003038
3039 # Run the tests
3040 # -------------
3041
Gilles Peskine14302ed2023-07-19 19:30:04 +02003042 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003043 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003044
Gilles Peskine14302ed2023-07-19 19:30:04 +02003045 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003046 tests/ssl-opt.sh
3047}
3048
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003049# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3050component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003051 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003052
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003053 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003054
Gilles Peskine21570cf2023-12-22 11:49:50 +01003055 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003056
Gilles Peskine14302ed2023-07-19 19:30:04 +02003057 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003058 make test
3059
Gilles Peskine14302ed2023-07-19 19:30:04 +02003060 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003061 tests/ssl-opt.sh
3062}
3063
Valerio Settie618cb02023-04-12 14:59:16 +02003064# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003065# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3066# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003067# to ensure that both tests use the same underlying configuration when testing
3068# driver's coverage with analyze_outcomes.py.
3069#
3070# This functions accepts 1 boolean parameter as follows:
3071# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3072# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3073# - 0: include built-in implementation of EC algorithms.
3074#
3075# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3076# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003077config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003078 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003079 # start with full config for maximum coverage (also enables USE_PSA)
3080 helper_libtestdriver1_adjust_config "full"
3081
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003082 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003083 # Disable modules that are accelerated
3084 scripts/config.py unset MBEDTLS_ECDSA_C
3085 scripts/config.py unset MBEDTLS_ECDH_C
3086 scripts/config.py unset MBEDTLS_ECJPAKE_C
3087 # Disable ECP module (entirely)
3088 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003089 fi
3090
Valerio Settiaecd32c2023-06-14 10:42:31 +02003091 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3092 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003093 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003094 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003095
Valerio Settie618cb02023-04-12 14:59:16 +02003096 # Restartable feature is not yet supported by PSA. Once it will in
3097 # the future, the following line could be removed (see issues
3098 # 6061, 6332 and following ones)
3099 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003100}
3101
3102# Build and test a configuration where driver accelerates all EC algs while
3103# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3104# side.
3105#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003106# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3107component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003108 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003109
3110 # Algorithms and key types to accelerate
3111 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3112 ALG_ECDH \
3113 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003114 $(helper_get_psa_key_type_list "ECC") \
3115 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003116
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003117 # Configure
3118 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003119
Valerio Settie618cb02023-04-12 14:59:16 +02003120 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003121 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003122 # Disable all the builtin curves. All the required algs are accelerated.
3123 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003124
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003125 # Build
3126 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003127
3128 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003129 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3130 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3131 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003132
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003133 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003134
Valerio Setti3fe105b2023-10-30 11:08:12 +01003135 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003136
3137 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3138 not grep mbedtls_ecdsa_ library/ecdsa.o
3139 not grep mbedtls_ecdh_ library/ecdh.o
3140 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003141 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003142 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003143
3144 # Run the tests
3145 # -------------
3146
Gilles Peskine14302ed2023-07-19 19:30:04 +02003147 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003148 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003149
Gilles Peskine14302ed2023-07-19 19:30:04 +02003150 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003151 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003152}
3153
3154# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003155# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003156# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003157component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003158 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003159
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003160 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003161
Gilles Peskine21570cf2023-12-22 11:49:50 +01003162 make
Valerio Settie618cb02023-04-12 14:59:16 +02003163
Gilles Peskine14302ed2023-07-19 19:30:04 +02003164 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003165 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003166
Gilles Peskine14302ed2023-07-19 19:30:04 +02003167 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003168 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003169}
3170
Valerio Setti4e2f2442023-08-15 10:10:26 +02003171# This is a common configuration helper used directly from:
3172# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3173# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3174# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003175# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003176# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003177# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003178# - this is the reference component of the above
3179# - it still disables RSA and FFDH, but it uses builtin EC algs
3180# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3181# - accelerate all EC and FFDH algs, disable only RSA
3182# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3183# - this is the reference component of the above
3184# - it still disables RSA, but it uses builtin EC and FFDH algs
3185#
3186# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003187# $1: a boolean value which states if we are testing an accelerated scenario
3188# or not.
3189# $2: a string value which states which components are tested. Allowed values
3190# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003191config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003192 driver_only="$1"
3193 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003194 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003195 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003196
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003197 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003198 # Disable modules that are accelerated
3199 scripts/config.py unset MBEDTLS_ECDSA_C
3200 scripts/config.py unset MBEDTLS_ECDH_C
3201 scripts/config.py unset MBEDTLS_ECJPAKE_C
3202 # Disable ECP module (entirely)
3203 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003204 # Also disable bignum
3205 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003206 fi
3207
3208 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3209 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3210 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3211 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3212
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003213 # RSA support is intentionally disabled on this test because RSA_C depends
3214 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003215 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3216 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 +02003217 scripts/config.py unset MBEDTLS_RSA_C
3218 scripts/config.py unset MBEDTLS_PKCS1_V15
3219 scripts/config.py unset MBEDTLS_PKCS1_V21
3220 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3221 # Also disable key exchanges that depend on RSA
3222 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3223 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3224 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3225 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3226 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3227
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003228 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003229 # When testing ECC only, we disable FFDH support, both from builtin and
3230 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003231 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003232 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 +01003233 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003234 scripts/config.py unset MBEDTLS_DHM_C
3235 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3236 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3237 else
3238 # When testing ECC and DH instead, we disable DHM and depending key
3239 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003240 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003241 scripts/config.py unset MBEDTLS_DHM_C
3242 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3243 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3244 fi
3245 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003246
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003247 # Restartable feature is not yet supported by PSA. Once it will in
3248 # the future, the following line could be removed (see issues
3249 # 6061, 6332 and following ones)
3250 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3251}
3252
Valerio Setti4e2f2442023-08-15 10:10:26 +02003253# Common helper used by:
3254# - component_test_psa_crypto_config_accel_ecc_no_bignum
3255# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003256#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003257# The goal is to build and test accelerating either:
3258# - ECC only or
3259# - both ECC and FFDH
3260#
3261# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003262# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3263# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003264common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003265 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003266
Valerio Setti5dfaca42023-09-05 08:48:51 +02003267 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003268 if [ "$test_target" = "ECC_DH" ]; then
3269 accel_text="ECC/FFDH"
3270 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003271 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003272 accel_text="ECC"
3273 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003274 fi
3275
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003276 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003277
3278 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003279 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3280 ALG_ECDH \
3281 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003282 $(helper_get_psa_key_type_list "ECC") \
3283 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003284 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003285 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003286 loc_accel_list="$loc_accel_list \
3287 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003288 $(helper_get_psa_key_type_list "DH") \
3289 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003290 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003291
3292 # Configure
3293 # ---------
3294
3295 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003296 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003297 # Disable all the builtin curves. All the required algs are accelerated.
3298 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003299
3300 # Build
3301 # -----
3302
3303 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003304 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3305 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3306 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003307
3308 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3309
Valerio Setti3fe105b2023-10-30 11:08:12 +01003310 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003311
3312 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3313 not grep mbedtls_ecdsa_ library/ecdsa.o
3314 not grep mbedtls_ecdh_ library/ecdh.o
3315 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003316 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003317 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003318 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003319 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003320 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003321
3322 # Run the tests
3323 # -------------
3324
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003325 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003326
Gilles Peskine21570cf2023-12-22 11:49:50 +01003327 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003328
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003329 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003330 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003331}
3332
Valerio Setti4e2f2442023-08-15 10:10:26 +02003333# Common helper used by:
3334# - component_test_psa_crypto_config_reference_ecc_no_bignum
3335# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3336#
3337# The goal is to build and test a reference scenario (i.e. with builtin
3338# components) compared to the ones used in
3339# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3340#
3341# It is meant to be used in conjunction with
3342# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3343# coverage analysis in "analyze_outcomes.py" script.
3344common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003345 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003346
Valerio Setti5dfaca42023-09-05 08:48:51 +02003347 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003348 if [ "$test_target" = "ECC_DH" ]; then
3349 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003350 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003351 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003352 fi
3353
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003354 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003355
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003356 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003357
Gilles Peskine21570cf2023-12-22 11:49:50 +01003358 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003359
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003360 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003361 make test
3362
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003363 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003364 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003365}
3366
Valerio Setti4e2f2442023-08-15 10:10:26 +02003367component_test_psa_crypto_config_accel_ecc_no_bignum () {
3368 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3369}
3370
3371component_test_psa_crypto_config_reference_ecc_no_bignum () {
3372 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3373}
3374
3375component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3376 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3377}
3378
3379component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3380 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3381}
3382
Valerio Settiac6d35f2023-08-04 12:49:11 +02003383# Helper for setting common configurations between:
3384# - component_test_tfm_config_p256m_driver_accel_ec()
3385# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003386common_tfm_config () {
3387 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003388 cp configs/config-tfm.h "$CONFIG_H"
3389 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3390 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003391
Yanray Wang73bb2312023-09-25 11:21:15 +08003392 # Other config adjustment to make the tests pass.
3393 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003394 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003395 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3396 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003397
Yanray Wang73bb2312023-09-25 11:21:15 +08003398 # Config adjustment for better test coverage in our environment.
3399 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003400 #
3401 # Enable filesystem I/O for the benefit of PK parse/write tests.
3402 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3403}
3404
Valerio Settiac6d35f2023-08-04 12:49:11 +02003405# Keep this in sync with component_test_tfm_config() as they are both meant
3406# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003407component_test_tfm_config_p256m_driver_accel_ec () {
3408 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3409
3410 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003411
Dave Rodgman897bb772023-11-15 16:34:20 +00003412 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003413 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003414
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003415 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3416 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003417 not grep mbedtls_ecdh_ library/ecdh.o
3418 not grep mbedtls_ecjpake_ library/ecjpake.o
3419 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3420 not grep mbedtls_ecp_ library/ecp.o
3421 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003422 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003423 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003424 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003425 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003426
Valerio Setti5e18b902023-12-04 12:07:30 +01003427 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3428 # files, so we want to ensure that it has not be re-enabled accidentally.
3429 not grep mbedtls_cipher library/cipher.o
3430
Valerio Settib7e95442023-03-21 11:52:33 +01003431 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003432 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003433 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003434}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003435
Valerio Settiac6d35f2023-08-04 12:49:11 +02003436# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3437# they are both meant to be used in analyze_outcomes.py for driver's coverage
3438# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003439component_test_tfm_config() {
3440 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003441
Dave Rodgman897bb772023-11-15 16:34:20 +00003442 # Disable P256M driver, which is on by default, so that analyze_outcomes
3443 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3444 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3445
Valerio Setti52ba0e32023-08-04 12:43:03 +02003446 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003447 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003448
Dave Rodgman897bb772023-11-15 16:34:20 +00003449 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003450 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003451
Valerio Setti5e18b902023-12-04 12:07:30 +01003452 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3453 # files, so we want to ensure that it has not be re-enabled accidentally.
3454 not grep mbedtls_cipher library/cipher.o
3455
Valerio Setti52ba0e32023-08-04 12:43:03 +02003456 msg "test: TF-M config"
3457 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003458}
3459
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003460# Common helper for component_full_without_ecdhe_ecdsa() and
3461# component_full_without_ecdhe_ecdsa_and_tls13() which:
3462# - starts from the "full" configuration minus the list of symbols passed in
3463# as 1st parameter
3464# - build
3465# - test only TLS (i.e. test_suite_tls and ssl-opt)
3466build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003467 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003468
3469 msg "build: full minus something, test TLS"
3470
3471 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003472 for sym in $symbols_to_disable; do
3473 echo "Disabling $sym"
3474 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003475 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003476
Gilles Peskine21570cf2023-12-22 11:49:50 +01003477 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003478
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003479 msg "test: full minus something, test TLS"
3480 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003481
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003482 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003483 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003484}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003485
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003486component_full_without_ecdhe_ecdsa () {
3487 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003488}
3489
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003490component_full_without_ecdhe_ecdsa_and_tls13 () {
3491 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3492 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003493}
3494
Valerio Setti249b18a2023-06-20 12:08:30 +02003495# This is an helper used by:
3496# - component_test_psa_ecc_key_pair_no_derive
3497# - component_test_psa_ecc_key_pair_no_generate
3498# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3499# enabled, but one. Input arguments are as follows:
3500# - $1 is the key type under test, i.e. ECC/RSA/DH
3501# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003502build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003503 key_type=$1
3504 unset_option=$2
3505 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003506
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003507 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003508 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003509 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3510 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3511
3512 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3513 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003514 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003515
Gilles Peskine21570cf2023-12-22 11:49:50 +01003516 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003517
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003518 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003519 make test
3520}
3521
3522component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003523 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003524}
3525
3526component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003527 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003528}
3529
Pengyu Lve705f572023-12-06 16:38:15 +08003530config_psa_crypto_accel_rsa () {
3531 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003532
Pengyu Lve705f572023-12-06 16:38:15 +08003533 # Start from crypto_full config (no X.509, no TLS)
3534 helper_libtestdriver1_adjust_config "crypto_full"
3535
3536 if [ "$driver_only" -eq 1 ]; then
3537 # Remove RSA support and its dependencies
3538 scripts/config.py unset MBEDTLS_RSA_C
3539 scripts/config.py unset MBEDTLS_PKCS1_V15
3540 scripts/config.py unset MBEDTLS_PKCS1_V21
3541
3542 # We need PEM parsing in the test library as well to support the import
3543 # of PEM encoded RSA keys.
3544 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3545 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3546 fi
3547}
3548
3549component_test_psa_crypto_config_accel_rsa_crypto () {
3550 msg "build: crypto_full with accelerated RSA"
3551
3552 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3553 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3554 KEY_TYPE_RSA_PUBLIC_KEY \
3555 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3556 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3557 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3558 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003559
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003560 # Configure
3561 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003562
Pengyu Lve705f572023-12-06 16:38:15 +08003563 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003564
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003565 # Build
3566 # -----
3567
Pengyu Lve705f572023-12-06 16:38:15 +08003568 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003569 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 +08003570 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003571 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003572
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003573 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003574
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003575 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003576 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003577
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003578 # Run the tests
3579 # -------------
3580
Pengyu Lve705f572023-12-06 16:38:15 +08003581 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003582 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003583}
3584
3585component_test_psa_crypto_config_reference_rsa_crypto () {
3586 msg "build: crypto_full with non-accelerated RSA"
3587
3588 # Configure
3589 # ---------
3590 config_psa_crypto_accel_rsa 0
3591
3592 # Build
3593 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003594 make
Pengyu Lve705f572023-12-06 16:38:15 +08003595
3596 # Run the tests
3597 # -------------
3598 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003599 make test
3600}
3601
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003602# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003603# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003604component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003605 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003606
Valerio Setti4590bc22023-06-13 15:39:23 +02003607 # Create a temporary output file unless there is already one set
3608 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3609 REMOVE_OUTCOME_ON_EXIT="no"
3610 else
3611 REMOVE_OUTCOME_ON_EXIT="yes"
3612 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3613 export MBEDTLS_TEST_OUTCOME_FILE
3614 fi
3615
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003616 # Start from crypto configuration
3617 scripts/config.py crypto
3618
3619 # Remove RSA support and its dependencies
3620 scripts/config.py unset MBEDTLS_PKCS1_V15
3621 scripts/config.py unset MBEDTLS_PKCS1_V21
3622 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3623 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3624 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3625 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3626 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3627 scripts/config.py unset MBEDTLS_RSA_C
3628 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3629
3630 # Enable PSA support
3631 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3632
Valerio Setti01cc88a2023-06-15 11:53:08 +02003633 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003634 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003635 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3636 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3637 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003638
3639 make
3640
Valerio Setti01cc88a2023-06-15 11:53:08 +02003641 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003642 make test
3643
3644 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3645 # performing RSA signature.
3646 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3647 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3648
3649 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3650 rm $MBEDTLS_TEST_OUTCOME_FILE
3651 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003652}
3653
Ronald Cronb2312452021-05-08 14:32:59 +02003654component_test_psa_crypto_config_accel_hash () {
3655 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3656
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003657 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3658 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3659 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003660
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003661 # Configure
3662 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003663
Ronald Cron46ac0652024-03-18 12:39:04 +01003664 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003665 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003666
3667 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003668 scripts/config.py unset MBEDTLS_MD5_C
3669 scripts/config.py unset MBEDTLS_RIPEMD160_C
3670 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003671 scripts/config.py unset MBEDTLS_SHA224_C
3672 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003673 scripts/config.py unset MBEDTLS_SHA384_C
3674 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003675 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003676
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003677 # Build
3678 # -----
3679
3680 helper_libtestdriver1_make_drivers "$loc_accel_list"
3681
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003682 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003683
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003684 # There's a risk of something getting re-enabled via config_psa.h;
3685 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3686 not grep mbedtls_md5 library/md5.o
3687 not grep mbedtls_sha1 library/sha1.o
3688 not grep mbedtls_sha256 library/sha256.o
3689 not grep mbedtls_sha512 library/sha512.o
3690 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003691
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003692 # Run the tests
3693 # -------------
3694
Ronald Cronb2312452021-05-08 14:32:59 +02003695 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3696 make test
3697}
3698
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003699# Auxiliary function to build config for hashes with and without drivers
3700config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003701 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003702 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003703 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003704 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003705 # disable the built-in implementation of hashes
3706 scripts/config.py unset MBEDTLS_MD5_C
3707 scripts/config.py unset MBEDTLS_RIPEMD160_C
3708 scripts/config.py unset MBEDTLS_SHA1_C
3709 scripts/config.py unset MBEDTLS_SHA224_C
3710 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003711 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003712 scripts/config.py unset MBEDTLS_SHA384_C
3713 scripts/config.py unset MBEDTLS_SHA512_C
3714 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003715 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003716 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003717}
3718
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003719# Note that component_test_psa_crypto_config_reference_hash_use_psa
3720# is related to this component and both components need to be kept in sync.
3721# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003722component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003723 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003724
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003725 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3726 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3727 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003728
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003729 # Configure
3730 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003731
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003732 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003733
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003734 # Build
3735 # -----
3736
3737 helper_libtestdriver1_make_drivers "$loc_accel_list"
3738
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003739 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003740
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003741 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003742 # 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 +02003743 not grep mbedtls_md5 library/md5.o
3744 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003745 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003746 not grep mbedtls_sha512 library/sha512.o
3747 not grep mbedtls_ripemd160 library/ripemd160.o
3748
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003749 # Run the tests
3750 # -------------
3751
Gilles Peskine14302ed2023-07-19 19:30:04 +02003752 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003753 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003754
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003755 # This is mostly useful so that we can later compare outcome files with
3756 # the reference config in analyze_outcomes.py, to check that the
3757 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003758 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003759 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003760
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003761 # This is to make sure all ciphersuites are exercised, but we don't need
3762 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003763 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003764 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003765}
3766
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003767# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3768# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3769# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3770# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003771component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003772 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003773
3774 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003775
Gilles Peskine21570cf2023-12-22 11:49:50 +01003776 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003777
Gilles Peskine14302ed2023-07-19 19:30:04 +02003778 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003779 make test
3780
Gilles Peskine14302ed2023-07-19 19:30:04 +02003781 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003782 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003783}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003784
Valerio Setti8eb310c2024-01-22 16:22:57 +01003785# Auxiliary function to build config for hashes with and without drivers
3786config_psa_crypto_hmac_use_psa () {
3787 driver_only="$1"
3788 # start with config full for maximum coverage (also enables USE_PSA)
3789 helper_libtestdriver1_adjust_config "full"
3790
Valerio Setticd89b0b2024-01-24 14:24:55 +01003791 if [ "$driver_only" -eq 1 ]; then
3792 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3793 # is still enabled though (for ENTROPY_C among others).
3794 scripts/config.py unset MBEDTLS_MD_C
3795 # Disable also the builtin hashes since they are supported by the driver
3796 # and MD module is able to perform PSA dispathing.
3797 scripts/config.py unset-all MBEDTLS_SHA
3798 scripts/config.py unset MBEDTLS_MD5_C
3799 scripts/config.py unset MBEDTLS_RIPEMD160_C
3800 fi
3801
Valerio Setti8eb310c2024-01-22 16:22:57 +01003802 # Direct dependencies of MD_C. We disable them also in the reference
3803 # component to work with the same set of features.
3804 scripts/config.py unset MBEDTLS_PKCS7_C
3805 scripts/config.py unset MBEDTLS_PKCS5_C
3806 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3807 scripts/config.py unset MBEDTLS_HKDF_C
3808 # Dependencies of HMAC_DRBG
3809 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3810 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3811}
3812
3813component_test_psa_crypto_config_accel_hmac() {
3814 msg "test: full with accelerated hmac"
3815
3816 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3817 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3818 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3819 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3820
3821 # Configure
3822 # ---------
3823
3824 config_psa_crypto_hmac_use_psa 1
3825
Valerio Setti8eb310c2024-01-22 16:22:57 +01003826 # Build
3827 # -----
3828
3829 helper_libtestdriver1_make_drivers "$loc_accel_list"
3830
3831 helper_libtestdriver1_make_main "$loc_accel_list"
3832
3833 # Ensure that built-in support for HMAC is disabled.
3834 not grep mbedtls_md_hmac library/md.o
3835
3836 # Run the tests
3837 # -------------
3838
3839 msg "test: full with accelerated hmac"
3840 make test
3841}
3842
3843component_test_psa_crypto_config_reference_hmac() {
3844 msg "test: full without accelerated hmac"
3845
3846 config_psa_crypto_hmac_use_psa 0
3847
3848 make
3849
3850 msg "test: full without accelerated hmac"
3851 make test
3852}
3853
Valerio Setti9da01a72023-12-18 17:38:18 +01003854component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003855 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003856
Valerio Setti9da01a72023-12-18 17:38:18 +01003857 # Albeit this components aims at accelerating DES which should only support
3858 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3859 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003860 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3861 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3862 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003863
Valerio Setti9da01a72023-12-18 17:38:18 +01003864 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3865 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3866 # of this component. This limitation will be addressed by #8598.
3867
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003868 # Configure
3869 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003870
Valerio Setti9a427302023-10-17 11:40:42 +02003871 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003872 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003873
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003874 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003875 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3876 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3877 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3878 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3879 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3880 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3881 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003882 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003883
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003884 # Build
3885 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003886
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003887 helper_libtestdriver1_make_drivers "$loc_accel_list"
3888
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003889 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003890
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003891 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003892 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003893
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003894 # Run the tests
3895 # -------------
3896
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003897 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003898 make test
3899}
3900
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003901component_test_psa_crypto_config_accel_aead () {
3902 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3903
Valerio Setti3f02bb72023-10-02 15:57:33 +02003904 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3905 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003906
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003907 # Configure
3908 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003909
Valerio Setti3f02bb72023-10-02 15:57:33 +02003910 # Start from full config
3911 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003912
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003913 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003914 scripts/config.py unset MBEDTLS_GCM_C
3915 scripts/config.py unset MBEDTLS_CCM_C
3916 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003917
Valerio Settia50b89e2023-11-08 15:58:47 +01003918 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3919 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003920
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003921 # Build
3922 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003923
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003924 helper_libtestdriver1_make_drivers "$loc_accel_list"
3925
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003926 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003927
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003928 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003929 not grep mbedtls_ccm library/ccm.o
3930 not grep mbedtls_gcm library/gcm.o
3931 not grep mbedtls_chachapoly library/chachapoly.o
3932
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003933 # Run the tests
3934 # -------------
3935
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003936 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3937 make test
3938}
3939
Valerio Settib680fc42023-10-13 09:29:37 +02003940# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003941# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3942# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3943common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003944 # Start from the full config
3945 helper_libtestdriver1_adjust_config "full"
3946
Valerio Settib680fc42023-10-13 09:29:37 +02003947 scripts/config.py unset MBEDTLS_NIST_KW_C
3948}
3949
Valerio Settib6b301f2023-10-04 12:05:05 +02003950# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003951# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3952# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003953# are meant to be used together in analyze_outcomes.py script in order to test
3954# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003955component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3956 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003957
Valerio Settiad8b7f02023-10-25 12:39:50 +02003958 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 +01003959 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003960 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003961 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3962
3963 # Configure
3964 # ---------
3965
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003966 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003967
3968 # Disable the things that are being accelerated
3969 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3970 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3971 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3972 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3973 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3974 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3975 scripts/config.py unset MBEDTLS_GCM_C
3976 scripts/config.py unset MBEDTLS_CCM_C
3977 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003978 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003979 scripts/config.py unset MBEDTLS_DES_C
3980 scripts/config.py unset MBEDTLS_AES_C
3981 scripts/config.py unset MBEDTLS_ARIA_C
3982 scripts/config.py unset MBEDTLS_CHACHA20_C
3983 scripts/config.py unset MBEDTLS_CAMELLIA_C
3984
Valerio Settiec9b2582023-11-08 16:50:54 +01003985 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3986 # does not depend on it.
3987 scripts/config.py unset MBEDTLS_CIPHER_C
3988
Valerio Settib6b301f2023-10-04 12:05:05 +02003989 # Build
3990 # -----
3991
3992 helper_libtestdriver1_make_drivers "$loc_accel_list"
3993
3994 helper_libtestdriver1_make_main "$loc_accel_list"
3995
3996 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003997 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003998 not grep mbedtls_des library/des.o
3999 not grep mbedtls_aes library/aes.o
4000 not grep mbedtls_aria library/aria.o
4001 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004002 not grep mbedtls_ccm library/ccm.o
4003 not grep mbedtls_gcm library/gcm.o
4004 not grep mbedtls_chachapoly library/chachapoly.o
4005 not grep mbedtls_cmac library/cmac.o
4006
4007 # Run the tests
4008 # -------------
4009
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004010 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004011 make test
Valerio Settif9414552023-11-09 10:43:20 +01004012
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004013 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004014 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004015
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004016 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004017 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004018}
4019
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004020component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4021 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4022 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004023
Gilles Peskine21570cf2023-12-22 11:49:50 +01004024 make
Valerio Settif9414552023-11-09 10:43:20 +01004025
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004026 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004027 make test
Valerio Settif9414552023-11-09 10:43:20 +01004028
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004029 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004030 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004031
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004032 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004033 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004034}
4035
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004036common_block_cipher_dispatch() {
4037 TEST_WITH_DRIVER="$1"
4038
4039 # Start from the full config
4040 helper_libtestdriver1_adjust_config "full"
4041
4042 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4043 # Disable key types that are accelerated (there is no legacy equivalent
4044 # symbol for ECB)
4045 scripts/config.py unset MBEDTLS_AES_C
4046 scripts/config.py unset MBEDTLS_ARIA_C
4047 scripts/config.py unset MBEDTLS_CAMELLIA_C
4048 fi
4049
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004050 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004051 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004052 # Keep this also in the reference component in order to skip the same tests
4053 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004054 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4055 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4056 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4057 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4058 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4059 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4060 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02004061 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004062
4063 # Disable direct dependency on AES_C
4064 scripts/config.py unset MBEDTLS_NIST_KW_C
4065
4066 # Prevent the cipher module from using deprecated PSA path. The reason is
4067 # that otherwise there will be tests relying on "aes_info" (defined in
4068 # "cipher_wrap.c") whose functions are not available when AES_C is
4069 # not defined. ARIA and Camellia are not a problem in this case because
4070 # the PSA path is not tested for these key types.
4071 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4072}
4073
Valerio Settif8e6cba2023-12-12 11:53:39 +01004074component_test_full_block_cipher_psa_dispatch () {
4075 msg "build: full + PSA dispatch in block_cipher"
4076
4077 loc_accel_list="ALG_ECB_NO_PADDING \
4078 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4079
4080 # Configure
4081 # ---------
4082
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004083 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004084
Valerio Settif8e6cba2023-12-12 11:53:39 +01004085 # Build
4086 # -----
4087
4088 helper_libtestdriver1_make_drivers "$loc_accel_list"
4089
4090 helper_libtestdriver1_make_main "$loc_accel_list"
4091
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004092 # Make sure disabled components were not re-enabled by accident (additive
4093 # config)
4094 not grep mbedtls_aes_ library/aes.o
4095 not grep mbedtls_aria_ library/aria.o
4096 not grep mbedtls_camellia_ library/camellia.o
4097
Valerio Settif8e6cba2023-12-12 11:53:39 +01004098 # Run the tests
4099 # -------------
4100
4101 msg "test: full + PSA dispatch in block_cipher"
4102 make test
4103}
4104
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004105# This is the reference component of component_test_full_block_cipher_psa_dispatch
4106component_test_full_block_cipher_legacy_dispatch () {
4107 msg "build: full + legacy dispatch in block_cipher"
4108
4109 common_block_cipher_dispatch 0
4110
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004111 make
4112
4113 msg "test: full + legacy dispatch in block_cipher"
4114 make test
4115}
4116
Gilles Peskine36dea152023-07-20 22:19:45 +02004117component_test_aead_chachapoly_disabled() {
4118 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004119 scripts/config.py full
4120 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004121 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004122 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004123
Gilles Peskine36dea152023-07-20 22:19:45 +02004124 msg "test: full minus CHACHAPOLY"
4125 make test
4126}
4127
4128component_test_aead_only_ccm() {
4129 msg "build: full minus CHACHAPOLY and GCM"
4130 scripts/config.py full
4131 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4132 scripts/config.py unset MBEDTLS_GCM_C
4133 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4134 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004135 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004136
4137 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004138 make test
4139}
4140
Ronald Crone501d0e2023-07-10 08:31:19 +02004141component_test_ccm_aes_sha256() {
4142 msg "build: CCM + AES + SHA256 configuration"
4143
Ronald Cron7612d8c2023-07-20 10:03:54 +02004144 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004145 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004146
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004147 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004148
4149 msg "test: CCM + AES + SHA256 configuration"
4150 make test
4151}
4152
Dave Rodgman904c5892023-06-28 17:36:02 +01004153support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004154 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004155}
4156
Dave Rodgman904c5892023-06-28 17:36:02 +01004157component_build_tfm_armcc() {
4158 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004159 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004160
Dave Rodgman88651c42023-06-29 12:35:51 +01004161 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004162 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 +01004163}
4164
4165component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004166 # Check that the TF-M configuration can build cleanly with various
4167 # warning flags enabled. We don't build or run tests, since the
4168 # TF-M configuration needs a TF-M platform. A tweaked version of
4169 # the configuration that works on mainstream platforms is in
4170 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004171 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004172
Dave Rodgman88651c42023-06-29 12:35:51 +01004173 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004174 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 +01004175
Dave Rodgman904c5892023-06-28 17:36:02 +01004176 msg "build: TF-M config, gcc native build"
4177 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004178 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 +01004179}
4180
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004181# Test that the given .o file builds with all (valid) combinations of the given options.
4182#
4183# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4184#
4185# The validator function is the name of a function to validate the combination of options.
4186# It may be "" if all combinations are valid.
4187# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004188# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004189build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004190 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004191 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004192 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004193 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004194 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004195
Dave Rodgman42436102023-10-03 15:47:05 +01004196 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004197 for opt in "${options[@]}"; do
4198 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004199 done
4200
4201 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004202 cd $(dirname ${file})
4203 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004204
Dave Rodgman920343a2023-10-01 18:41:09 +01004205 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004206 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 +01004207
Dave Rodgman42436102023-10-03 15:47:05 +01004208 # Extract the command generated by the Makefile to build the target file.
4209 # This ensures that we have any include paths, macro definitions, etc
4210 # that may be applied by make.
4211 # 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 +01004212 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004213
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004214 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004215 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004216
Dave Rodgman28e38d82023-10-04 11:50:30 +01004217 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004218 source_file=${file%.o}.c
4219
4220 targets=0
4221 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004222
Dave Rodgman28e38d82023-10-04 11:50:30 +01004223 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004224 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004225 # each bit of $i is used to determine if options[i] will be set or not
4226 target="t"
4227 clang_args=""
4228 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004229 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004230 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004231 clang_args="${clang_args} ${opt}"
4232 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004233 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004234 done
4235
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004236 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004237 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004238 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004239 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004240
Dave Rodgman28e38d82023-10-04 11:50:30 +01004241 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004242 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004243 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004244 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004245
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004246 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004247
Dave Rodgman920343a2023-10-01 18:41:09 +01004248 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004249 make -s -f ${makefile} build_test_config_combos
4250 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004251
4252 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004253 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004254}
4255
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004256validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004257 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4258 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004259 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004260 fi
4261 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4262 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004263 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004264 fi
4265 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004266 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004267}
4268
4269component_build_aes_variations() {
4270 # 18s - around 90ms per clang invocation on M1 Pro
4271 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004272 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004273 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004274
Yanray Wangbc29aef2023-11-06 11:08:17 +08004275 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004276 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004277
Dave Rodgman42436102023-10-03 15:47:05 +01004278 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004279 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4280 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4281 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4282 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004283
4284 cd "$MBEDTLS_ROOT_DIR"
4285 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4286
Yanray Wang42be1ba2023-11-23 14:28:47 +08004287 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004288 # manually set or unset those configurations to check
4289 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004290 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4291 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4292 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4293 scripts/config.py unset MBEDTLS_DES_C
4294 scripts/config.py unset MBEDTLS_NIST_KW_C
4295 build_test_config_combos library/aes.o validate_aes_config_variations \
4296 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4297 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4298 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4299 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004300}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004301
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004302component_test_no_platform () {
4303 # Full configuration build, without platform support, file IO and net sockets.
4304 # This should catch missing mbedtls_printf definitions, and by disabling file
4305 # IO, it should catch missing '#include <stdio.h>'
4306 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004307 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004308 scripts/config.py unset MBEDTLS_PLATFORM_C
4309 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004310 scripts/config.py unset MBEDTLS_FS_IO
4311 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004312 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004313 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004314 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004315 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004316 # to re-enable platform integration features otherwise disabled in C99 builds
4317 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004318 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004319}
Gilles Peskine7c652162017-12-11 00:01:40 +01004320
4321component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004322 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004323 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4324 scripts/config.py full
4325 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004326 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4327 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4328 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4329 make
4330}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004331
Gilles Peskine8f073122018-11-27 15:58:47 +01004332component_build_no_ssl_srv () {
4333 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004334 scripts/config.py full
4335 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004336 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004337}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004338
Gilles Peskine8f073122018-11-27 15:58:47 +01004339component_build_no_ssl_cli () {
4340 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004341 scripts/config.py full
4342 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004343 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004344}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004345
Gilles Peskine8f073122018-11-27 15:58:47 +01004346component_build_no_sockets () {
4347 # Note, C99 compliance can also be tested with the sockets support disabled,
4348 # as that requires a POSIX platform (which isn't the same as C99).
4349 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004350 scripts/config.py full
4351 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4352 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4353 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4354}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004355
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004356component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004357 msg "build: default config with memory buffer allocator and backtrace enabled"
4358 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4359 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4360 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004361 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004362 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004363 make
4364
4365 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4366 make test
4367}
4368
4369component_test_memory_buffer_allocator () {
4370 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004371 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4372 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004373 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004374 make
4375
4376 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4377 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004378
4379 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4380 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004381 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004382}
4383
Gilles Peskine8f073122018-11-27 15:58:47 +01004384component_test_no_max_fragment_length () {
4385 # Run max fragment length tests with MFL disabled
4386 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004387 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004388 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004389 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004390
Gilles Peskine8f073122018-11-27 15:58:47 +01004391 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004392 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004393}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004394
Hanno Becker545ced42019-02-19 11:10:48 +00004395component_test_asan_remove_peer_certificate () {
4396 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004397 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004398 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004399 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004400 make
4401
4402 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4403 make test
4404
4405 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004406 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004407
4408 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004409 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004410
4411 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004412 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004413}
4414
Gilles Peskine8f073122018-11-27 15:58:47 +01004415component_test_no_max_fragment_length_small_ssl_out_content_len () {
4416 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004417 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4418 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4419 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004420 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004421 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004422
Gilles Peskine8f073122018-11-27 15:58:47 +01004423 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004424 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004425
4426 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004427 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004428}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004429
Darryl Greenaad82f92019-12-02 10:53:11 +00004430component_test_variable_ssl_in_out_buffer_len () {
4431 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4432 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004433 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004434 make
4435
4436 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4437 make test
4438
4439 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004440 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004441
4442 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004443 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004444}
4445
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004446component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004447 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004448 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004449
Dave Rodgman17127e92023-12-14 16:42:48 +00004450 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004451 make
4452
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004453 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004454 make test
4455
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004456 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004457 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004458
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004459 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004460 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004461}
4462
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004463component_test_ssl_alloc_buffer_and_mfl () {
4464 msg "build: default config with memory buffer allocator and MFL extension"
4465 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4466 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4467 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4468 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4469 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004470 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004471 make
4472
4473 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4474 make test
4475
4476 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 +02004477 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004478}
4479
Gilles Peskine636c26a2020-03-04 20:46:15 +01004480component_test_when_no_ciphersuites_have_mac () {
4481 msg "build: when no ciphersuites have MAC"
4482 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004483 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004484 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004485 make
4486
4487 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4488 make test
4489
4490 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004491 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004492}
4493
Raoul Strackxa4e86142020-06-15 17:03:13 +02004494component_test_no_date_time () {
4495 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4496 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004497 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004498 make
4499
4500 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4501 make test
4502}
4503
Gilles Peskine8f073122018-11-27 15:58:47 +01004504component_test_platform_calloc_macro () {
4505 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004506 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4507 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4508 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004509 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004510 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004511
Gilles Peskine8f073122018-11-27 15:58:47 +01004512 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4513 make test
4514}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004515
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004516component_test_malloc_0_null () {
4517 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004518 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004519 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 +02004520
4521 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4522 make test
4523
4524 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4525 # Just the calloc selftest. "make test" ran the others as part of the
4526 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004527 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004528
4529 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4530 # Run a subset of the tests. The choice is a balance between coverage
4531 # and time (including time indirectly wasted due to flaky tests).
4532 # The current choice is to skip tests whose description includes
4533 # "proxy", which is an approximation of skipping tests that use the
4534 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004535 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004536}
4537
Dave Rodgman6a08b682023-06-19 11:51:33 +01004538support_test_aesni() {
4539 # Check that gcc targets x86_64 (we can build AESNI), and check for
4540 # AESNI support on the host (we can run AESNI).
4541 #
4542 # The name of this function is possibly slightly misleading, but needs to align
4543 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004544 #
4545 # In principle 32-bit x86 can support AESNI, but our implementation does not
4546 # support 32-bit x86, so we check for x86-64.
4547 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004548 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4549 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004550 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004551}
4552
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004553component_test_aesni () { # ~ 60s
4554 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4555 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4556 #
4557 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4558 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4559 # exercise the plain C impl).
4560
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004561 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004562 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004563 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004564 scripts/config.py set MBEDTLS_HAVE_ASM
4565
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004566 # test the intrinsics implementation
4567 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004568 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004569 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004570 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004571 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004572
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004573 # test the asm implementation
4574 msg "AES tests, test assembly"
4575 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004576 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004577 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004578 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004579
4580 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004581 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004582 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004583 msg "AES tests, plain C"
4584 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004585 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004586 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004587 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004588 not grep -q "AES note: using AESNI" ./programs/test/selftest
4589 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004590
4591 # test the intrinsics implementation
4592 scripts/config.py set MBEDTLS_AESNI_C
4593 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4594 msg "AES tests, test AESNI only"
4595 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004596 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004597 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4598 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004599 grep -q "AES note: using AESNI" ./programs/test/selftest
4600 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004601}
4602
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004603component_test_sha3_variations() {
4604 msg "sha3 loop unroll variations"
4605
4606 # define minimal config sufficient to test SHA3
4607 cat > include/mbedtls/mbedtls_config.h << END
4608 #define MBEDTLS_SELF_TEST
4609 #define MBEDTLS_SHA3_C
4610END
4611
4612 msg "all loops unrolled"
4613 make clean
4614 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"
4615 ./tests/test_suite_shax
4616
4617 msg "all loops rolled up"
4618 make clean
4619 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"
4620 ./tests/test_suite_shax
4621}
4622
Jerry Yub6d39c22023-08-16 15:11:48 +08004623support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004624 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004625}
4626
4627component_test_aesni_m32 () { # ~ 60s
4628 # This tests are duplicated from component_test_aesni for i386 target
4629 #
4630 # AESNI intrinsic code supports i386 and assembly code does not support it.
4631
4632 msg "build: default config with different AES implementations"
4633 scripts/config.py set MBEDTLS_AESNI_C
4634 scripts/config.py set MBEDTLS_PADLOCK_C
4635 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4636 scripts/config.py set MBEDTLS_HAVE_ASM
4637
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004638 # test the intrinsics implementation with gcc
4639 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004640 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004641 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004642 # check that we built intrinsics - this should be used by default when supported by the compiler
4643 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4644 grep -q "AES note: using AESNI" ./programs/test/selftest
4645 grep -q "AES note: built-in implementation." ./programs/test/selftest
4646 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4647 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4648
4649 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004650 scripts/config.py unset MBEDTLS_PADLOCK_C
4651 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4652 msg "AES tests, test AESNI only"
4653 make clean
4654 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4655 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4656 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4657 grep -q "AES note: using AESNI" ./programs/test/selftest
4658 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4659 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4660 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4661}
4662
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004663support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004664 # clang >= 4 is required to build with target attributes
4665 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004666}
4667
4668component_test_aesni_m32_clang() {
4669
4670 scripts/config.py set MBEDTLS_AESNI_C
4671 scripts/config.py set MBEDTLS_PADLOCK_C
4672 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4673 scripts/config.py set MBEDTLS_HAVE_ASM
4674
4675 # test the intrinsics implementation with clang
4676 msg "AES tests, test intrinsics (clang)"
4677 make clean
4678 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4679 # check that we built intrinsics - this should be used by default when supported by the compiler
4680 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4681 grep -q "AES note: using AESNI" ./programs/test/selftest
4682 grep -q "AES note: built-in implementation." ./programs/test/selftest
4683 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4684 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4685}
4686
Jerry Yu193cbc02023-08-03 17:06:29 +08004687# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4688component_build_aes_aesce_armcc () {
4689 msg "Build: AESCE test on arm64 platform without plain C."
4690 scripts/config.py baremetal
4691
4692 # armc[56] don't support SHA-512 intrinsics
4693 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4694
4695 # Stop armclang warning about feature detection for A64_CRYPTO.
4696 # With this enabled, the library does build correctly under armclang,
4697 # but in baremetal builds (as tested here), feature detection is
4698 # unavailable, and the user is notified via a #warning. So enabling
4699 # this feature would prevent us from building with -Werror on
4700 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004701 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004702 scripts/config.py set MBEDTLS_HAVE_ASM
4703
4704 msg "AESCE, build with default configuration."
4705 scripts/config.py set MBEDTLS_AESCE_C
4706 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4707 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4708
4709 msg "AESCE, build AESCE only"
4710 scripts/config.py set MBEDTLS_AESCE_C
4711 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4712 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4713}
4714
Dave Rodgman0c584032023-10-08 12:26:54 +01004715support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004716 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004717 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004718}
4719
4720component_build_aes_armce () {
4721 # Test variations of AES with Armv8 crypto extensions
4722 scripts/config.py set MBEDTLS_AESCE_C
4723 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4724
4725 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004726 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004727
4728 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4729 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4730
4731 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4732 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4733
Dave Rodgman5e419372023-10-23 15:30:20 +01004734 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004735
Dave Rodgman5e419372023-10-23 15:30:20 +01004736 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4737 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004738
Dave Rodgman5e419372023-10-23 15:30:20 +01004739 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4740 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004741
Dave Rodgman5e419372023-10-23 15:30:20 +01004742 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4743 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004744
4745 # test for presence of AES instructions
4746 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4747 msg "clang, test A32 crypto instructions built"
4748 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4749 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4750 msg "clang, test T32 crypto instructions built"
4751 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4752 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4753 msg "clang, test aarch64 crypto instructions built"
4754 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4755 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4756
4757 # test for absence of AES instructions
4758 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4759 scripts/config.py unset MBEDTLS_AESCE_C
4760 msg "clang, test A32 crypto instructions not built"
4761 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4762 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4763 msg "clang, test T32 crypto instructions not built"
4764 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4765 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4766 msg "clang, test aarch64 crypto instructions not built"
4767 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4768 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004769}
4770
Dave Rodgman9ed18532023-10-05 00:06:47 +01004771support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004772 # clang >= 4 is required to build with SHA extensions
4773 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004774}
4775
Dave Rodgmand9e80832023-10-04 17:17:46 +01004776component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004777 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004778
4779
4780 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004781 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004782 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4783 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4784 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4785 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4786 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004787
Dave Rodgmand9e80832023-10-04 17:17:46 +01004788
Dave Rodgman94a634d2023-10-10 12:59:29 +01004789 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004790 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004791 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4792 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4793 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004794
Dave Rodgman5b89c552023-10-10 14:59:02 +01004795 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004796 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4797 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4798 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004799
Dave Rodgmancd654002023-10-05 09:40:07 +01004800
Dave Rodgman94a634d2023-10-10 12:59:29 +01004801 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004802 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004803 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4804 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4805 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4806 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4807 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004808
Dave Rodgmancd654002023-10-05 09:40:07 +01004809
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004810 # examine the disassembly for presence of SHA instructions
4811 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4812 scripts/config.py set ${opt}
4813 msg "${opt} clang, test A32 crypto instructions built"
4814 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4815 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4816
4817 msg "${opt} clang, test T32 crypto instructions built"
4818 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4819 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4820
4821 msg "${opt} clang, test aarch64 crypto instructions built"
4822 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4823 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4824 scripts/config.py unset ${opt}
4825 done
4826
4827
4828 # examine the disassembly for absence of SHA instructions
4829 msg "clang, test A32 crypto instructions not built"
4830 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4831 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4832
4833 msg "clang, test T32 crypto instructions not built"
4834 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4835 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4836
4837 msg "clang, test aarch64 crypto instructions not built"
4838 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4839 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004840}
4841
Jerry Yuc935aa62023-08-03 17:08:27 +08004842# For timebeing, no VIA Padlock platform available.
4843component_build_aes_via_padlock () {
4844
4845 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004846 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004847 scripts/config.py set MBEDTLS_PADLOCK_C
4848 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004849 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004850 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004851
4852}
4853
4854support_build_aes_via_padlock_only () {
4855 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4856 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4857 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4858}
4859
Jerry Yu193cbc02023-08-03 17:06:29 +08004860support_build_aes_aesce_armcc () {
4861 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004862}
4863
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004864component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004865 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004866 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004867 scripts/config.py unset MBEDTLS_PADLOCK_C
4868
Dave Rodgmand8d64512023-12-19 12:20:21 +00004869 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004870
4871 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4872 make test
4873}
4874
4875component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4876 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4877 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004878 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4879 scripts/config.py unset MBEDTLS_PADLOCK_C
4880
Hanno Becker83ebf782017-07-07 12:29:15 +01004881 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004882
4883 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004884 make test
4885}
Gilles Peskine8f073122018-11-27 15:58:47 +01004886
Hanno Becker83ebf782017-07-07 12:29:15 +01004887component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004888 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4889 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4890 scripts/config.py unset MBEDTLS_PADLOCK_C
4891 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004892 scripts/config.py unset MBEDTLS_AESCE_C
4893
Dave Rodgmand8d64512023-12-19 12:20:21 +00004894 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004895
4896 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004897 make test
4898
4899 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4900 programs/test/selftest
4901}
4902
Matthias Schulz0767fda2024-02-07 10:46:28 +01004903component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004904 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4905 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004906 scripts/config.py unset MBEDTLS_PADLOCK_C
4907 scripts/config.py unset MBEDTLS_AESNI_C
4908 scripts/config.py unset MBEDTLS_AESCE_C
4909
4910 make CFLAGS='-O2 -Werror -Wall -Wextra'
4911
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004912 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004913 make test
4914}
4915
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004916component_test_aes_fewer_tables () {
4917 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004918 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004919 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004920
Gilles Peskine7c652162017-12-11 00:01:40 +01004921 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004922 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004923}
4924
4925component_test_aes_rom_tables () {
4926 msg "build: default config with AES_ROM_TABLES enabled"
4927 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004928 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004929
4930 msg "test: AES_ROM_TABLES"
4931 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004932}
4933
Gilles Peskine14c3c062018-01-29 21:25:12 +01004934component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004935 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4936 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4937 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004938 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004939
Gilles Peskine8f073122018-11-27 15:58:47 +01004940 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4941 make test
4942}
4943
Yanray Wang49cd4b52023-11-10 11:58:37 +08004944# helper for common_block_cipher_no_decrypt() which:
4945# - enable/disable the list of config options passed from -s/-u respectively.
4946# - build
4947# - test for tests_suite_xxx
4948# - selftest
4949#
4950# Usage: helper_block_cipher_no_decrypt_build_test
4951# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4952# Options: -s set_opts the list of config options to enable
4953# -u unset_opts the list of config options to disable
4954# -c cflags the list of options passed to CFLAGS
4955# -l ldflags the list of options passed to LDFLAGS
4956helper_block_cipher_no_decrypt_build_test () {
4957 while [ $# -gt 0 ]; do
4958 case "$1" in
4959 -s)
4960 shift; local set_opts="$1";;
4961 -u)
4962 shift; local unset_opts="$1";;
4963 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004964 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004965 -l)
4966 shift; local ldflags="$1";;
4967 esac
4968 shift
4969 done
4970 set_opts="${set_opts:-}"
4971 unset_opts="${unset_opts:-}"
4972 cflags="${cflags:-}"
4973 ldflags="${ldflags:-}"
4974
Yanray Wangb2d6e522023-11-13 16:57:47 +08004975 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4976 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004977
4978 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4979 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004980 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004981
4982 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4983 not grep mbedtls_aes_setkey_dec library/aes.o
4984 not grep mbedtls_aria_setkey_dec library/aria.o
4985 not grep mbedtls_camellia_setkey_dec library/camellia.o
4986 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4987 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004988 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4989 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004990
4991 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4992 make test
4993
4994 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4995 programs/test/selftest
4996}
4997
4998# This is a common configuration function used in:
4999# - component_test_block_cipher_no_decrypt_aesni_legacy()
5000# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5001# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5002# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5003# on x86.
5004common_block_cipher_no_decrypt () {
5005 # test AESNI intrinsics
5006 helper_block_cipher_no_decrypt_build_test \
5007 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005008 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005009
5010 # test AESNI assembly
5011 helper_block_cipher_no_decrypt_build_test \
5012 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005013 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005014
5015 # test AES C implementation
5016 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005017 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005018
5019 # test AESNI intrinsics for i386 target
5020 helper_block_cipher_no_decrypt_build_test \
5021 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005022 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005023 -l "-m32"
5024}
5025
Yanray Wang3ae11992023-11-13 17:32:09 +08005026# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5027# usage: 0: no PSA crypto configuration
5028# 1: use PSA crypto configuration
5029config_block_cipher_no_decrypt () {
5030 use_psa=$1
5031
Yanray Wang66111392023-10-31 18:54:54 +08005032 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005033 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5034 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005035 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005036 scripts/config.py unset MBEDTLS_NIST_KW_C
5037
Yanray Wang3ae11992023-11-13 17:32:09 +08005038 if [ "$use_psa" -eq 1 ]; then
5039 # Enable support for cryptographic mechanisms through the PSA API.
5040 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5041 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5042 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5043 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5044 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5045 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5046 fi
5047}
5048
5049component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005050 # This consistently causes an llvm crash on clang 3.8, so use gcc
5051 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005052 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005053 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005054}
5055
Yanray Wangf1496402023-11-01 18:55:13 +08005056component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005057 # This consistently causes an llvm crash on clang 3.8, so use gcc
5058 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005059 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005060 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005061}
5062
Yanray Wang66111392023-10-31 18:54:54 +08005063support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005064 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005065}
5066
Yanray Wang66111392023-10-31 18:54:54 +08005067component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005068 scripts/config.py baremetal
5069
5070 # armc[56] don't support SHA-512 intrinsics
5071 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5072
5073 # Stop armclang warning about feature detection for A64_CRYPTO.
5074 # With this enabled, the library does build correctly under armclang,
5075 # but in baremetal builds (as tested here), feature detection is
5076 # unavailable, and the user is notified via a #warning. So enabling
5077 # this feature would prevent us from building with -Werror on
5078 # armclang. Tracked in #7198.
5079 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5080 scripts/config.py set MBEDTLS_HAVE_ASM
5081
Yanray Wang3ae11992023-11-13 17:32:09 +08005082 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005083
5084 # test AESCE baremetal build
5085 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005086 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005087 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005088
Yanray Wangef1b04d2023-09-08 11:09:26 +08005089 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5090 not grep mbedtls_aes_setkey_dec library/aes.o
5091 not grep mbedtls_aria_setkey_dec library/aria.o
5092 not grep mbedtls_camellia_setkey_dec library/camellia.o
5093 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5094 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005095 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005096 not grep mbedtls_aesce_inverse_key library/aesce.o
5097 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005098}
5099
Gilles Peskine592f5912019-10-07 18:49:32 +02005100component_test_ctr_drbg_aes_256_sha_256 () {
5101 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5102 scripts/config.py full
5103 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5104 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005105 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005106 make
5107
5108 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5109 make test
5110}
5111
5112component_test_ctr_drbg_aes_128_sha_512 () {
5113 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005114 scripts/config.py full
5115 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5116 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005117 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005118 make
5119
5120 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5121 make test
5122}
5123
5124component_test_ctr_drbg_aes_128_sha_256 () {
5125 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005126 scripts/config.py full
5127 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5128 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5129 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005130 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005131 make
5132
5133 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5134 make test
5135}
5136
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005137component_test_se_default () {
5138 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005139 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005140 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005141
5142 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5143 make test
5144}
5145
Steven Cooremand57203d2020-07-16 20:28:59 +02005146component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005147 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005148 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005149 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005150 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5151 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005152 loc_cflags="${loc_cflags} -I../tests/include -O2"
5153
Gilles Peskine21570cf2023-12-22 11:49:50 +01005154 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005155
Gilles Peskine1997f302023-07-26 18:45:20 +02005156 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005157 make test
5158}
5159
Gilles Peskine8f073122018-11-27 15:58:47 +01005160component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005161 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005162 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005163 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005164 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005165}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005166
Gilles Peskinecf740502019-07-03 20:43:05 +02005167component_test_cmake_shared () {
5168 msg "build/test: cmake shared" # ~ 2min
5169 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5170 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005171 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005172 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005173 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005174}
5175
Gilles Peskineec10bf12019-09-20 19:56:06 +02005176test_build_opt () {
5177 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005178 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005179 for opt in "$@"; do
5180 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005181 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005182 # We're confident enough in compilers to not run _all_ the tests,
5183 # but at least run the unit tests. In particular, runs with
5184 # optimizations use inline assembly whereas runs with -O0
5185 # skip inline assembly.
5186 make test # ~30s
5187 make clean
5188 done
5189}
5190
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005191# For FreeBSD we invoke the function by name so this condition is added
5192# to disable the existing test_clang_opt function for linux.
5193if [[ $(uname) != "Linux" ]]; then
5194 component_test_clang_opt () {
5195 scripts/config.py full
5196 test_build_opt 'full config' clang -O0 -Os -O2
5197 }
5198fi
5199
5200component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005201 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005202 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005203}
5204support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005205 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005206}
5207
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005208component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005209 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005210 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005211}
5212support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005213 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005214}
5215
5216component_test_gcc_latest_opt () {
5217 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005218 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005219}
5220support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005221 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005222}
5223
5224component_test_gcc_earliest_opt () {
5225 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005226 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005227}
5228support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005229 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005230}
5231
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005232component_build_mbedtls_config_file () {
5233 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005234 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005235 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005236 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005237 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005238 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5239 make clean
5240
5241 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5242 # In the user config, disable one feature (for simplicity, pick a feature
5243 # that nothing else depends on).
5244 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005245 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005246 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5247
5248 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005249}
5250
Gilles Peskine7d904e72022-04-07 21:59:14 +02005251component_build_psa_config_file () {
5252 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5253 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5254 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5255 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5256 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005257 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005258 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5259 make clean
5260
5261 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005262 # In the user config, disable one feature and its dependencies, which will
5263 # reflect on the mbedtls configuration so we can query it with
5264 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005265 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005266 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005267 scripts/config.py unset MBEDTLS_CMAC_C
5268 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5269 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5270
5271 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005272}
5273
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005274component_build_psa_alt_headers () {
5275 msg "build: make with PSA alt headers" # ~20s
5276
5277 # Generate alternative versions of the substitutable headers with the
5278 # same content except different include guards.
5279 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5280
5281 # Build the library and some programs.
5282 # Don't build the fuzzers to avoid having to go through hoops to set
5283 # a correct include path for programs/fuzz/Makefile.
5284 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
5285 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\"'"
5286
5287 # Check that we're getting the alternative include guards and not the
5288 # original include guards.
5289 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5290 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5291 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5292 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5293}
5294
Dave Rodgman852de3c2023-12-14 14:46:45 +00005295component_test_m32_no_asm () {
5296 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005297 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005298 #
5299 # Note that we require gcc, because clang Asan builds fail to link for
5300 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005301 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005302 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005303 scripts/config.py unset MBEDTLS_HAVE_ASM
5304 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005305 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005306 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005307
Dave Rodgman852de3c2023-12-14 14:46:45 +00005308 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005309 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005310}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005311support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005312 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005313 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005314 *) false;;
5315 esac
5316}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005317
Gilles Peskineff0aee02021-10-05 09:36:03 +02005318component_test_m32_o2 () {
5319 # Build with optimization, to use the i386 specific inline assembly
5320 # and go faster for tests.
5321 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005322 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005323 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005324 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005325
Gilles Peskineff0aee02021-10-05 09:36:03 +02005326 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005327 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005328
Gilles Peskineff0aee02021-10-05 09:36:03 +02005329 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005330 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005331}
Gilles Peskinecf522222021-10-07 19:25:29 +02005332support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005333 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005334}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005335
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005336component_test_m32_everest () {
5337 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005338 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005339 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005340 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005341
5342 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5343 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005344
5345 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005346 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005347
5348 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5349 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005350 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005351}
5352support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005353 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005354}
5355
Gilles Peskine8f073122018-11-27 15:58:47 +01005356component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005357 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005358 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005359 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005360
5361 msg "test: 64-bit ILP32, make, gcc"
5362 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005363}
Gilles Peskine878cf602019-01-06 20:50:38 +00005364support_test_mx32 () {
5365 case $(uname -m) in
5366 amd64|x86_64) true;;
5367 *) false;;
5368 esac
5369}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005370
Peter Kolbus60c6da22018-12-27 06:59:04 -06005371component_test_min_mpi_window_size () {
5372 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005373 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005374 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005375 make
5376
5377 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5378 make test
5379}
5380
Gilles Peskine8f073122018-11-27 15:58:47 +01005381component_test_have_int32 () {
5382 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005383 scripts/config.py unset MBEDTLS_HAVE_ASM
5384 scripts/config.py unset MBEDTLS_AESNI_C
5385 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005386 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005387 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005388
Gilles Peskine8f073122018-11-27 15:58:47 +01005389 msg "test: gcc, force 32-bit bignum limbs"
5390 make test
5391}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005392
Gilles Peskine8f073122018-11-27 15:58:47 +01005393component_test_have_int64 () {
5394 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005395 scripts/config.py unset MBEDTLS_HAVE_ASM
5396 scripts/config.py unset MBEDTLS_AESNI_C
5397 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005398 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005399 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005400
Gilles Peskine8f073122018-11-27 15:58:47 +01005401 msg "test: gcc, force 64-bit bignum limbs"
5402 make test
5403}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005404
Gabor Mezeie256cc12023-07-26 17:28:48 +02005405component_test_have_int32_cmake_new_bignum () {
5406 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5407 scripts/config.py unset MBEDTLS_HAVE_ASM
5408 scripts/config.py unset MBEDTLS_AESNI_C
5409 scripts/config.py unset MBEDTLS_PADLOCK_C
5410 scripts/config.py unset MBEDTLS_AESCE_C
5411 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005412 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005413 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005414
5415 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5416 make test
5417}
5418
Gilles Peskine8f073122018-11-27 15:58:47 +01005419component_test_no_udbl_division () {
5420 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005421 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005422 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005423 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005424
Gilles Peskine8f073122018-11-27 15:58:47 +01005425 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5426 make test
5427}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005428
Gilles Peskine8f073122018-11-27 15:58:47 +01005429component_test_no_64bit_multiplication () {
5430 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005431 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005432 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005433 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005434
Gilles Peskine8f073122018-11-27 15:58:47 +01005435 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5436 make test
5437}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005438
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005439component_test_no_strings () {
5440 msg "build: no strings" # ~10s
5441 scripts/config.py full
5442 # Disable options that activate a large amount of string constants.
5443 scripts/config.py unset MBEDTLS_DEBUG_C
5444 scripts/config.py unset MBEDTLS_ERROR_C
5445 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5446 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005447 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005448
5449 msg "test: no strings" # ~ 10s
5450 make test
5451}
5452
Hanno Beckerc5722d12020-10-09 11:10:42 +01005453component_test_no_x509_info () {
5454 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5455 scripts/config.pl full
5456 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5457 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005458 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005459
5460 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5461 make test
5462
5463 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005464 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005465}
5466
Gilles Peskine8f073122018-11-27 15:58:47 +01005467component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005468 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005469 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005470 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 +02005471
Gilles Peskinee36fe812021-09-01 20:00:33 +02005472 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005473 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005474}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005475
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005476component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005477 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005478 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005479 # Build for a target platform that's close to what Debian uses
5480 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005481 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005482 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005483 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005484 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'
5485
Gilles Peskinee36fe812021-09-01 20:00:33 +02005486 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005487 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005488}
5489support_build_arm_linux_gnueabi_gcc_arm5vte () {
5490 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5491}
5492
5493component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005494 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005495 scripts/config.py baremetal
5496 # This is an imperfect substitute for
5497 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005498 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005499 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 +02005500
Gilles Peskinee36fe812021-09-01 20:00:33 +02005501 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005502 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005503}
5504
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005505component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005506 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5507 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005508 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 +02005509
Gilles Peskinee36fe812021-09-01 20:00:33 +02005510 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005511 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005512 for lib in library/*.a; do
5513 echo "$lib:"
5514 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5515 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005516}
5517
Gilles Peskine8f073122018-11-27 15:58:47 +01005518component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005519 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005520 scripts/config.py baremetal
5521 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005522 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 +01005523 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005524 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005525}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005526
Gilles Peskine8f073122018-11-27 15:58:47 +01005527component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005528 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005529 scripts/config.py baremetal
5530 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005531 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 +01005532 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005533 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005534}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005535
Dave Rodgman8c315f22023-06-02 10:26:24 -04005536component_build_arm_clang_thumb () {
5537 # ~ 30s
5538
5539 scripts/config.py baremetal
5540
5541 msg "build: clang thumb 2, make"
5542 make clean
5543 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5544
5545 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5546 msg "build: clang thumb 1 -O0, make"
5547 make clean
5548 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5549
5550 msg "build: clang thumb 1 -Os, make"
5551 make clean
5552 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5553}
5554
Gilles Peskine8f073122018-11-27 15:58:47 +01005555component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005556 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005557 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005558 # armc[56] don't support SHA-512 intrinsics
5559 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005560
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005561 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5562 scripts/config.py unset MBEDTLS_AESCE_C
5563
Dave Rodgman0fddf822023-03-02 15:32:12 +00005564 # Stop armclang warning about feature detection for A64_CRYPTO.
5565 # With this enabled, the library does build correctly under armclang,
5566 # but in baremetal builds (as tested here), feature detection is
5567 # unavailable, and the user is notified via a #warning. So enabling
5568 # this feature would prevent us from building with -Werror on
5569 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005570 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005571
Hanno Beckerf0762e92022-07-15 12:08:19 +01005572 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005573
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005574 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005575
5576 msg "size: ARM Compiler 5"
5577 "$ARMC5_FROMELF" -z library/*.o
5578
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005579 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005580
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005581 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005582 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005583
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005584 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005585 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5586
5587 # ARM Compiler 6 - Target ARMv7-M+DSP
5588 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005589
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005590 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005591 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005592
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005593 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005594 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005595
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005596 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5597 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5598
Dave Rodgman99318e62023-05-24 12:27:42 +01005599 # ARM Compiler 6 - Target Cortex-M0
5600 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005601
5602 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5603 #
5604 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5605 # that we have in our CI
5606 scripts/config.py set MBEDTLS_AESCE_C
5607 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005608}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005609
Pengyu Lvdf070032023-02-24 16:03:31 +08005610support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005611 armc5_cc="$ARMC5_BIN_DIR/armcc"
5612 armc6_cc="$ARMC6_BIN_DIR/armclang"
5613 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005614}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005615
Ronald Crond2cb7f42024-03-18 12:49:18 +01005616component_test_tls12_only () {
5617 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5618 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5619 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5620 make
5621
5622 msg "test: main suites (inc. selftests) (ASan build)"
5623 make test
5624
5625 msg "test: ssl-opt.sh (ASan build)"
5626 tests/ssl-opt.sh
5627
5628 msg "test: compat.sh (ASan build)"
5629 tests/compat.sh
5630}
5631
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005632component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005633 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005634 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005635 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005636 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5637
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005638 msg "test: TLS 1.3 only, all key exchange modes enabled"
5639 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005640
Ronald Cronc3f43b62022-10-17 17:35:32 +02005641 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5642 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005643}
5644
Ronald Cronc3f43b62022-10-17 17:35:32 +02005645component_test_tls13_only_psk () {
5646 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5647 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5648 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5649 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005650 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005651 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5652 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5653 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5654 scripts/config.py unset MBEDTLS_ECDSA_C
5655 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005656 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005657 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005658 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5659
Ronald Cronc3f43b62022-10-17 17:35:32 +02005660 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5661 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005662
Ronald Cronc3f43b62022-10-17 17:35:32 +02005663 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5664 tests/ssl-opt.sh
5665}
5666
5667component_test_tls13_only_ephemeral () {
5668 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5669 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5670 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005671 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005672 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5673
5674 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5675 cd tests; ./test_suite_ssl; cd ..
5676
5677 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5678 tests/ssl-opt.sh
5679}
5680
Przemek Stekiela01c2422023-06-13 10:46:48 +02005681component_test_tls13_only_ephemeral_ffdh () {
5682 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5683 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5684 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5685 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005686 scripts/config.py unset MBEDTLS_ECDH_C
5687
Przemek Stekiela01c2422023-06-13 10:46:48 +02005688 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5689
5690 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5691 cd tests; ./test_suite_ssl; cd ..
5692
5693 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5694 tests/ssl-opt.sh
5695}
5696
Ronald Cronc3f43b62022-10-17 17:35:32 +02005697component_test_tls13_only_psk_ephemeral () {
5698 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5699 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5700 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5701 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5702 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5703 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5704 scripts/config.py unset MBEDTLS_ECDSA_C
5705 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005706 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005707 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005708 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5709
5710 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5711 cd tests; ./test_suite_ssl; cd ..
5712
5713 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5714 tests/ssl-opt.sh
5715}
5716
Przemek Stekiela01c2422023-06-13 10:46:48 +02005717component_test_tls13_only_psk_ephemeral_ffdh () {
5718 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5719 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5720 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5721 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5722 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5723 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5724 scripts/config.py unset MBEDTLS_ECDSA_C
5725 scripts/config.py unset MBEDTLS_PKCS1_V21
5726 scripts/config.py unset MBEDTLS_PKCS7_C
5727 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005728 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005729 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5730
5731 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5732 cd tests; ./test_suite_ssl; cd ..
5733
5734 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5735 tests/ssl-opt.sh
5736}
5737
Ronald Cronc3f43b62022-10-17 17:35:32 +02005738component_test_tls13_only_psk_all () {
5739 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5740 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5741 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5742 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5743 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5744 scripts/config.py unset MBEDTLS_ECDSA_C
5745 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005746 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005747 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005748 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5749
5750 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5751 cd tests; ./test_suite_ssl; cd ..
5752
5753 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5754 tests/ssl-opt.sh
5755}
5756
5757component_test_tls13_only_ephemeral_all () {
5758 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5759 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005760 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005761 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5762
5763 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5764 cd tests; ./test_suite_ssl; cd ..
5765
5766 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5767 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005768}
5769
Ronald Cron46ac0652024-03-18 12:39:04 +01005770component_test_tls13_no_padding () {
5771 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005772 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005773 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005774 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005775 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005776 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005777 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005778 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005779 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005780}
5781
Ronald Cron6f135e12021-12-08 16:57:54 +01005782component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005783 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005784 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005785 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005786 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005787 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005788 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005789 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005790 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005791 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005792}
5793
Ronald Crondd96c0a2024-04-02 12:34:24 +02005794component_test_full_minus_session_tickets() {
5795 msg "build: full config without session tickets"
5796 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005797 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005798 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005799 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5800 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005801 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005802 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005803 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005804 tests/ssl-opt.sh
5805}
5806
Gilles Peskine8f073122018-11-27 15:58:47 +01005807component_build_mingw () {
5808 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005809 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 +00005810
Gilles Peskine8f073122018-11-27 15:58:47 +01005811 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005812 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 +01005813 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005814
Gilles Peskine8f073122018-11-27 15:58:47 +01005815 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005816 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
5817 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 +01005818 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005819
Pengyu Lv158eead2023-10-19 11:27:05 +08005820 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005821 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005822 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 +01005823 make WINDOWS_BUILD=1 clean
5824}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005825support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005826 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5827 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005828 *) true;;
5829 esac
5830}
Simon Butcher91aef332016-11-17 09:20:50 +00005831
Gilles Peskine8f073122018-11-27 15:58:47 +01005832component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005833 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005834 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005835 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5836 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005837
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005838 msg "test: main suites (MSan)" # ~ 10s
5839 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005840
Gilles Peskine6848d172023-11-02 19:58:03 +01005841 msg "test: metatests (MSan)"
5842 tests/scripts/run-metatests.sh any msan
5843
Gilles Peskine82b27272019-06-14 18:27:03 +02005844 msg "program demos (MSan)" # ~20s
5845 tests/scripts/run_demos.py
5846
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005847 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005848 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005849
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005850 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005851
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005852 if [ "$MEMORY" -gt 0 ]; then
5853 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005854 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005855 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005856}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005857
Bence Szépkúti0354d042023-12-06 16:14:37 +01005858component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005859 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005860 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005861 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5862 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005863
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005864 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005865 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005866
Gilles Peskine636c26a2020-03-04 20:46:15 +01005867 # Optional parts (slow; currently broken on OS X because programs don't
5868 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005869 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005870 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005871 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005872 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005873 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005874
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005875 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005876 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005877 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005878 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005879
5880 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005881 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005882 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005883 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005884}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005885
Bence Szépkúti0354d042023-12-06 16:14:37 +01005886component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005887 msg "build: Release, full (clang)"
5888 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5889 scripts/config.py full
5890 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5891 make
5892
5893 msg "test: main suites, Valgrind (full config)"
5894 make memcheck
5895}
5896
Paul Elliott62dc3922021-11-25 17:29:40 +00005897support_test_cmake_out_of_source () {
5898 distrib_id=""
5899 distrib_ver=""
5900 distrib_ver_minor=""
5901 distrib_ver_major=""
5902
5903 # Attempt to parse lsb-release to find out distribution and version. If not
5904 # found this should fail safe (test is supported).
5905 if [[ -f /etc/lsb-release ]]; then
5906
5907 while read -r lsb_line; do
5908 case "$lsb_line" in
5909 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5910 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5911 esac
5912 done < /etc/lsb-release
5913
5914 distrib_ver_major="${distrib_ver%%.*}"
5915 distrib_ver="${distrib_ver#*.}"
5916 distrib_ver_minor="${distrib_ver%%.*}"
5917 fi
5918
5919 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5920 # processor (as the CI does) can create a race condition whereby the build
5921 # fails to see a generated file, despite that file actually having been
5922 # generated. This problem appears to go away with 18.04 or newer, so make
5923 # the out of source tests unsupported on Ubuntu 16.04.
5924 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5925}
5926
Gilles Peskine8f073122018-11-27 15:58:47 +01005927component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005928 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005929 # generates
5930 make neat
5931
Gilles Peskine8f073122018-11-27 15:58:47 +01005932 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005933 MBEDTLS_ROOT_DIR="$PWD"
5934 mkdir "$OUT_OF_SOURCE_DIR"
5935 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005936 # Note: Explicitly generate files as these are turned off in releases
5937 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005938 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005939
Gilles Peskine8f073122018-11-27 15:58:47 +01005940 msg "test: cmake 'out-of-source' build"
5941 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005942 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005943 # Also ensure that there are no error messages such as
5944 # "No such file or directory", which would indicate that some required
5945 # file is missing (ssl-opt.sh tolerates the absence of some files so
5946 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005947 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005948 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005949 cat ssl-opt.err >&2
5950 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005951 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005952 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005953 cd "$MBEDTLS_ROOT_DIR"
5954 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005955}
Andres AGdc192212016-08-31 17:33:13 +01005956
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005957component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005958 # Remove existing generated files so that we use the ones CMake
5959 # generates
5960 make neat
5961
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005962 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005963 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005964 # Note: Explicitly generate files as these are turned off in releases
5965 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005966 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005967 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005968}
Gilles Peskinea3000992022-02-04 00:21:12 +01005969support_test_cmake_as_subdirectory () {
5970 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005971}
5972
Chris Kayd259e342021-03-25 16:03:25 +00005973component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005974 # Remove existing generated files so that we use the ones CMake
5975 # generates
5976 make neat
5977
Chris Kayd259e342021-03-25 16:03:25 +00005978 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005979 cd programs/test/cmake_package
5980 cmake .
5981 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005982 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005983}
Gilles Peskinea3000992022-02-04 00:21:12 +01005984support_test_cmake_as_package () {
5985 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005986}
5987
5988component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005989 # Remove existing generated files so that we use the ones CMake
5990 # generates
5991 make neat
5992
Chris Kayd259e342021-03-25 16:03:25 +00005993 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005994 cd programs/test/cmake_package_install
5995 cmake .
5996 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005997 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005998}
Gilles Peskinea3000992022-02-04 00:21:12 +01005999support_test_cmake_as_package_install () {
6000 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006001}
6002
David Horstmann20550e32023-01-12 14:17:01 +00006003component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006004 # Make a copy of config file to use for the in-tree test
6005 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006006
6007 MBEDTLS_ROOT_DIR="$PWD"
6008 mkdir "$OUT_OF_SOURCE_DIR"
6009 cd "$OUT_OF_SOURCE_DIR"
6010
David Horstmann969c1452023-01-31 10:34:44 +00006011 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006012 cmake "$MBEDTLS_ROOT_DIR"
6013 make
6014
6015 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6016 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006017 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006018 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6019 make
6020
6021 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6022 # In the user config, disable one feature (for simplicity, pick a feature
6023 # that nothing else depends on).
6024 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6025
6026 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6027 make
6028 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6029
6030 rm -f user_config.h full_config.h
6031
6032 cd "$MBEDTLS_ROOT_DIR"
6033 rm -rf "$OUT_OF_SOURCE_DIR"
6034
6035 # Now repeat the test for an in-tree build:
6036
David Horstmann969c1452023-01-31 10:34:44 +00006037 # Restore config for the in-tree test
6038 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006039
David Horstmann969c1452023-01-31 10:34:44 +00006040 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006041 cmake .
6042 make
6043
6044 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6045 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006046 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006047 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6048 make
6049
6050 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6051 # In the user config, disable one feature (for simplicity, pick a feature
6052 # that nothing else depends on).
6053 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6054
6055 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6056 make
6057 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6058
6059 rm -f user_config.h full_config.h
6060}
6061support_build_cmake_custom_config_file () {
6062 support_test_cmake_out_of_source
6063}
6064
David Horstmann041ed422024-05-10 14:37:48 +01006065component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006066 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006067 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6068 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6069 make
6070}
6071support_build_cmake_programs_no_testing () {
6072 support_test_cmake_out_of_source
6073}
David Horstmann20550e32023-01-12 14:17:01 +00006074
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006075component_build_zeroize_checks () {
6076 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6077
6078 scripts/config.py full
6079
6080 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006081 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 +01006082}
6083
6084
Gilles Peskine8f073122018-11-27 15:58:47 +01006085component_test_zeroize () {
6086 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6087 # different combinations of compilers and optimization flags by using an
6088 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6089 # system in all cases that the script fails, so we must manually search the
6090 # output to check whether the pass string is present and no failure strings
6091 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006092
Gilles Peskine4976e822019-01-06 19:52:22 +00006093 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6094 # about a spurious message if Gdb tries and fails, so suppress that.
6095 gdb_disable_aslr=
6096 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6097 gdb_disable_aslr='set disable-randomization off'
6098 fi
6099
Gilles Peskine8f073122018-11-27 15:58:47 +01006100 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006101 for compiler in clang gcc; do
6102 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6103 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006104 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6105 grep "The buffer was correctly zeroized" test_zeroize.log
6106 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006107 rm -f test_zeroize.log
6108 make clean
6109 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006110 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006111}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006112
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006113component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006114 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006115 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006116 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006117
6118 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006119 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006120}
6121
6122support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006123 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006124 ver="$(cmake --version)"
6125 ver="${ver#cmake version }"
6126 ver_major="${ver%%.*}"
6127
6128 ver="${ver#*.}"
6129 ver_minor="${ver%%.*}"
6130
6131 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006132}
6133
Gilles Peskinec848d222022-12-09 12:23:35 +01006134component_check_code_style () {
6135 msg "Check C code style"
6136 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006137}
6138
Gilles Peskinec848d222022-12-09 12:23:35 +01006139support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006140 case $(uncrustify --version) in
6141 *0.75.1*) true;;
6142 *) false;;
6143 esac
6144}
6145
Gilles Peskine8f073122018-11-27 15:58:47 +01006146component_check_python_files () {
6147 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006148 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006149}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006150
Joe Subbianid614c0b2021-07-29 11:18:29 +01006151component_check_test_helpers () {
6152 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006153 # unittest writes out mundane stuff like number or tests run on stderr.
6154 # Our convention is to reserve stderr for actual errors, and write
6155 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006156 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006157
Joe Subbiania25ffab2021-08-06 09:41:27 +01006158 msg "unit test: translate_ciphers.py"
6159 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006160}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006161
Valerio Settid9e42512024-05-06 15:59:51 +02006162component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006163 msg "build library for server"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006164 scripts/config.py crypto
Valerio Settid1b6ef12024-05-07 16:00:21 +02006165 helper_crypto_client_build server
6166
Valerio Settif98635c2024-06-10 20:13:13 +02006167 msg "build server"
6168 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_partition
6169
6170 # cleanup() will restore some backed-up files which include $CONFIG_H and
6171 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
6172 # point.
6173 cleanup
6174
6175 msg "build library for client"
6176 helper_crypto_client_build client
6177
6178 msg "build psasim to test psa_client"
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01006179 rm -f tests/psa-client-server/psasim/test/psa_client # In case left behind
Valerio Settif98635c2024-06-10 20:13:13 +02006180 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client
Valerio Settid9e42512024-05-06 15:59:51 +02006181
6182 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006183 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006184
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006185
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006186 msg "build psasim to test psa_hash_compute"
6187 # Delete the executable to ensure we build using the right MAIN
6188 rm tests/psa-client-server/psasim/test/psa_client
6189 # API under test: psa_hash_compute()
Valerio Settif98635c2024-06-10 20:13:13 +02006190 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash_compute.c" test/psa_client
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006191
6192 msg "test psasim running psa_hash_compute"
6193 tests/psa-client-server/psasim/test/run_test.sh
6194
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006195
Valerio Settif98635c2024-06-10 20:13:13 +02006196 # Next APIs under test: psa_hash_*(). Use our copy of the PSA hash example.
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006197 msg "build psasim to test all psa_hash_* APIs"
6198 # Delete the executable to ensure we build using the right MAIN
6199 rm tests/psa-client-server/psasim/test/psa_client
Valerio Settif98635c2024-06-10 20:13:13 +02006200 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash.c" test/psa_client
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006201
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006202 msg "test psasim running psa_hash sample"
6203 tests/psa-client-server/psasim/test/run_test.sh
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006204
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006205
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01006206 # Next APIs under test: psa_aead_*(). Use our copy of the PSA aead example.
6207 msg "build psasim to test all psa_aead_* APIs"
6208 # Delete the executable to ensure we build using the right MAIN
6209 rm tests/psa-client-server/psasim/test/psa_client
6210 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_aead_demo.c" test/psa_client
6211
6212 msg "test psasim running psa_aead_demo sample"
6213 tests/psa-client-server/psasim/test/run_test.sh aes128-gcm
6214 tests/psa-client-server/psasim/test/run_test.sh aes256-gcm
6215 tests/psa-client-server/psasim/test/run_test.sh aes128-gcm_8
6216 tests/psa-client-server/psasim/test/run_test.sh chachapoly
Gilles Peskine8f073122018-11-27 15:58:47 +01006217
6218 msg "clean psasim"
6219 make -C tests/psa-client-server/psasim clean
6220}
6221
6222################################################################
6223#### Termination
Gilles Peskine5d996822020-03-28 21:09:21 +01006224################################################################
6225
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006226post_report () {
Gilles Peskine5d996822020-03-28 21:09:21 +01006227 msg "Done, cleaning up"
6228 final_cleanup
6229
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006230 final_report
6231}
6232
Gilles Peskineec135542021-08-02 23:14:03 +02006233
Gilles Peskine5d996822020-03-28 21:09:21 +01006234
Gilles Peskineec135542021-08-02 23:14:03 +02006235################################################################
Gilles Peskine5d996822020-03-28 21:09:21 +01006236#### Run all the things
Gilles Peskineec135542021-08-02 23:14:03 +02006237################################################################
Gilles Peskine5d996822020-03-28 21:09:21 +01006238
6239# Function invoked by --error-test to test error reporting.
6240pseudo_component_error_test () {
6241 msg "Testing error reporting $error_test_i"
Gilles Peskinee48351a2018-11-27 16:06:30 +01006242 if [ $KEEP_GOING -ne 0 ]; then
Gilles Peskine8f073122018-11-27 15:58:47 +01006243 echo "Expect three failing commands."
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006244 fi
Gilles Peskine9004a172019-09-16 15:20:36 +02006245 # If the component doesn't run in a subshell, changing error_test_i to an
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006246 # invalid integer will cause an error in the loop that runs this function.
6247 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
6248 # Expected error: 'grep non_existent /dev/null -> 1'
6249 grep non_existent /dev/null
Gilles Peskine88a07452021-07-08 19:03:50 +02006250 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
6251 not grep -q . "$0"
6252 # Expected error: 'make unknown_target -> 2'
Tom Cosgrove226aca12022-03-16 14:11:07 +00006253 make unknown_target
Gilles Peskine88a07452021-07-08 19:03:50 +02006254 false "this should not be executed"
6255}
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006256
Gilles Peskineec135542021-08-02 23:14:03 +02006257# Run one component and clean up afterwards.
6258run_component () {
Gilles Peskinece266c42020-03-28 18:50:43 +01006259 current_component="$1"
Gilles Peskineec135542021-08-02 23:14:03 +02006260 export MBEDTLS_TEST_CONFIGURATION="$current_component"
6261
Gilles Peskinece266c42020-03-28 18:50:43 +01006262 # Unconditionally create a seedfile that's sufficiently long.
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006263 # Do this before each component, because a previous component may
Gilles Peskinece266c42020-03-28 18:50:43 +01006264 # have messed it up or shortened it.
6265 local dd_cmd
6266 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6267 case $OSTYPE in
6268 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
6269 esac
6270 "${dd_cmd[@]}"
6271
6272 # Run the component in a subshell, with error trapping and output
6273 # redirection set up based on the relevant options.
6274 if [ $KEEP_GOING -eq 1 ]; then
6275 # We want to keep running if the subshell fails, so 'set -e' must
6276 # be off when the subshell runs.
6277 set +e
6278 fi
6279 (
6280 if [ $QUIET -eq 1 ]; then
6281 # msg() will be silenced, so just print the component name here.
6282 echo "${current_component#component_}"
6283 exec >/dev/null
6284 fi
6285 if [ $KEEP_GOING -eq 1 ]; then
6286 # Keep "set -e" off, and run an ERR trap instead to record failures.
6287 set -E
6288 trap err_trap ERR
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006289 fi
6290 # The next line is what runs the component
Gilles Peskinee48351a2018-11-27 16:06:30 +01006291 "$@"
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006292 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskine8f073122018-11-27 15:58:47 +01006293 trap - ERR
6294 exit $last_failure_status
6295 fi
6296 )
6297 component_status=$?
6298 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006299 set -e
Dave Rodgman21900632024-02-26 11:41:19 +00006300 if [ $component_status -ne 0 ]; then
Gilles Peskine878cf602019-01-06 20:50:38 +00006301 failure_count=$((failure_count + 1))
Gilles Peskine568f53a2021-07-12 18:16:01 +02006302 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +02006303 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -05006304
Gilles Peskine878cf602019-01-06 20:50:38 +00006305 # Restore the build tree to a clean state.
6306 cleanup
6307 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006308}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006309
Gilles Peskine878cf602019-01-06 20:50:38 +00006310# Preliminary setup
6311pre_check_environment
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006312pre_initialize_variables
David Horstmann76a77382023-08-17 17:32:26 +01006313pre_parse_command_line "$@"
David Horstmann9a6c45b2023-07-14 12:30:00 +01006314
6315setup_quiet_wrappers
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006316pre_check_git
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006317pre_restore_files
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006318pre_back_up
Gilles Peskine5d996822020-03-28 21:09:21 +01006319
Gilles Peskine5d996822020-03-28 21:09:21 +01006320build_status=0
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006321if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006322 pre_setup_keep_going
6323fi
6324pre_prepare_outcome_file
Gilles Peskine8f073122018-11-27 15:58:47 +01006325pre_print_configuration
6326pre_check_tools
Gilles Peskine878cf602019-01-06 20:50:38 +00006327cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006328if in_mbedtls_repo; then
6329 pre_generate_files
6330fi
6331
6332# Run the requested tests.
6333for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
6334 run_component pseudo_component_error_test
6335done
6336unset error_test_i
6337for component in $RUN_COMPONENTS; do
6338 run_component "component_$component"
6339done
6340
6341# We're done.
6342post_report