blob: d0dcc99c3d765c5ea1b676d2041a9cdeaaaac5e9 [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 Cron561181c2024-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'
David Horstmann76a77382023-08-17 17:32:26 +0100136 else
137 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100138 fi
John Durkopbd069d32020-10-31 22:14:03 -0700139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100140 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200141
142 # Files that are clobbered by some jobs will be backed up. Use a different
143 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
144 # independently decide when to remove the backup file.
145 backup_suffix='.all.bak'
146 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100147 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100148 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 # Files clobbered by in-tree cmake
150 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
151 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200152
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200153 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100154 MEMORY=0
155 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200156 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100158
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200159 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200160 #
161 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
162 # both values are kept in sync. If you change the value here because it
163 # breaks some tests, you'll definitely want to change it in
164 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200165 RELEASE_SEED=1
166
Yanray Wang18040ed2023-11-23 21:29:56 +0800167 # Specify character collation for regular expressions and sorting with C locale
168 export LC_COLLATE=C
169
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200170 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200171 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200172 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200173 export MBEDTLS_TEST_PLATFORM
174
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000175 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL_NEXT:="$OPENSSL"}
178 : ${GNUTLS_CLI:="gnutls-cli"}
179 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100180 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
181 : ${ARMC5_BIN_DIR:=/usr/bin}
182 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200183 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200184 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100185 : ${CLANG_LATEST:="clang-latest"}
186 : ${CLANG_EARLIEST:="clang-earliest"}
187 : ${GCC_LATEST:="gcc-latest"}
188 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000190 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200191 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100192 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000193 # if CC is not set, use clang by default (if present) to improve build times
194 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000195 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000196 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000197
Ronald Cron561181c2024-04-02 14:39:53 +0200198 if [ -n "${OPENSSL_3+set}" ]; then
199 export OPENSSL_NEXT="$OPENSSL_3"
200 fi
201
Gilles Peskine396853a2021-09-20 18:57:55 +0200202 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000203 export CTEST_OUTPUT_ON_FAILURE=1
204
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100206 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200207 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000208 # Normally, tests should use this compiler for ASAN testing
209 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200210
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400211 # Platform tests have an allocation that returns null
212 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400213 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400214
Gilles Peskine878cf602019-01-06 20:50:38 +0000215 # Gather the list of available components. These are the functions
216 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100217 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000218
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000219 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100220 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100221}
Andres AG38495a32016-07-12 16:54:33 +0100222
Dave Rodgman21900632024-02-26 11:41:19 +0000223setup_quiet_wrappers()
224{
225 # Pick up "quiet" wrappers for make and cmake, which don't output very much
226 # unless there is an error. This reduces logging overhead in the CI.
227 #
228 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000229 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
230 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000231 fi
232}
233
Gilles Peskinea28db922019-01-10 00:05:18 +0100234# Test whether the component $1 is included in the command line patterns.
235is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100236{
Gilles Peskine03af6782021-08-06 11:35:17 +0200237 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
238 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000240 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100241 set +f
242 case ${1#component_} in $pattern) return 0;; esac
243 done
244 set +f
245 return 1
246}
Andres AG7770ea82016-10-10 15:46:20 +0100247
Simon Butcher41eeccf2016-09-07 00:07:09 +0100248usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100249{
Gilles Peskine709346a2017-12-10 23:43:39 +0100250 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100251Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100252Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100253By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100254COMPONENT can be the name of a component or a shell wildcard pattern.
255
256Examples:
257 $0 "check_*"
258 Run all sanity checks.
259 $0 --no-armcc --except test_memsan
260 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100261
262Special options:
263 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000264 --list-all-components List all available test components and exit.
265 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100266
267General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200268 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100270 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100271 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200272 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200273 --arm-none-eabi-gcc-prefix=<string>
274 Prefix for a cross-compiler for arm-none-eabi
275 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200276 --arm-linux-gnueabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-linux-gnueabi
278 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100279 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200280 --restore First clean up the build tree, restoring backed up
281 files. Do not run any components unless they are
282 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100283 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200284 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100285 --except Exclude the COMPONENTs listed on the command line,
286 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200287 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100288 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100289 --no-force Refuse to overwrite modified files (default).
290 --no-keep-going Stop at the first error (default).
291 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800292 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100293 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --outcome-file=<path> File where test outcomes are written (not done if
295 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200297 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100298 -s|--seed Integer seed value to use for this test run.
299
300Tool path options:
301 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
302 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100303 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
304 --clang-latest=<Clang_latest_path> Latest version of clang available
305 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
306 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100307 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
308 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100310 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100311EOF
SimonB2e23c822016-04-16 21:54:39 +0100312}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200314# Cleanup before/after running a component.
315# Remove built files as well as the cmake cache/config.
316# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100317cleanup()
318{
David Horstmann76a77382023-08-17 17:32:26 +0100319 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100320 command make clean
321 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200322
Gilles Peskine31b07e22018-03-21 12:15:06 +0100323 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000324 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100325 -iname CMakeFiles -exec rm -rf {} \+ -o \
326 \( -iname cmake_install.cmake -o \
327 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200328 -iname CMakeCache.txt -o \
329 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200331 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200332
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100333 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
334 rm -rf programs/test/cmake_subproject/build
335 rm -f programs/test/cmake_subproject/Makefile
336 rm -f programs/test/cmake_subproject/cmake_subproject
337
Chris Kayd259e342021-03-25 16:03:25 +0000338 # Remove any artifacts from the component_test_cmake_as_package test.
339 rm -rf programs/test/cmake_package/build
340 rm -f programs/test/cmake_package/Makefile
341 rm -f programs/test/cmake_package/cmake_package
342
343 # Remove any artifacts from the component_test_cmake_as_installed_package test.
344 rm -rf programs/test/cmake_package_install/build
345 rm -f programs/test/cmake_package_install/Makefile
346 rm -f programs/test/cmake_package_install/cmake_package_install
347
Gilles Peskinef83eb822020-03-30 20:11:39 +0200348 # Restore files that may have been clobbered by the job
349 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200350 if [[ -e "$x$backup_suffix" ]]; then
351 cp -p "$x$backup_suffix" "$x"
352 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 done
354}
John Durkopbd069d32020-10-31 22:14:03 -0700355
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200356# Final cleanup when this script exits (except when exiting on a failure
357# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358final_cleanup () {
359 cleanup
360
361 for x in $files_to_back_up; do
362 rm -f "$x$backup_suffix"
363 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100364}
365
Gilles Peskine7c652162017-12-11 00:01:40 +0100366# Executed on exit. May be redefined depending on command line options.
367final_report () {
368 :
369}
370
371fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200372 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100373 final_report $1
374 trap - $1
375 kill -$1 $$
376}
377
378trap 'fatal_signal HUP' HUP
379trap 'fatal_signal INT' INT
380trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200381
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200382# Number of processors on this machine. Used as the default setting
383# for parallel make.
384all_sh_nproc ()
385{
386 {
387 nproc || # Linux
388 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
389 sysctl -n hw.ncpu || # FreeBSD
390 echo 1
391 } 2>/dev/null
392}
393
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100394msg()
395{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100396 if [ -n "${current_component:-}" ]; then
397 current_section="${current_component#component_}: $1"
398 else
399 current_section="$1"
400 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200401
402 if [ $QUIET -eq 1 ]; then
403 return
404 fi
405
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo ""
407 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100408 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000409 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100410 echo "******************************************************************"
411}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100412
Gilles Peskine8f073122018-11-27 15:58:47 +0100413armc6_build_test()
414{
415 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100416
Gilles Peskine18487f62020-04-30 23:11:54 +0200417 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800418 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100419 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000420 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200421
422 msg "size: ARM Compiler 6 ($FLAGS)"
423 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100424}
Andres AGa5cd9732016-10-17 15:23:10 +0100425
Andres AGd9eba4b2016-08-26 14:42:14 +0100426err_msg()
427{
428 echo "$1" >&2
429}
430
431check_tools()
432{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200433 for tool in "$@"; do
434 if ! `type "$tool" >/dev/null 2>&1`; then
435 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100436 exit 1
437 fi
438 done
439}
440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000442 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100443 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100444 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100445 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200446 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000447 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100448
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000449 # Note that legacy options are ignored instead of being omitted from this
450 # list of options, so invocations that worked with previous version of
451 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100452 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100453 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200454 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200455 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200456 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000457 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100458 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
459 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100460 --clang-earliest) shift; CLANG_EARLIEST="$1";;
461 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100462 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000463 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100464 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100465 --gcc-earliest) shift; GCC_EARLIEST="$1";;
466 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200468 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
469 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-serv) shift; GNUTLS_SERV="$1";;
471 --help|-h) usage; exit;;
472 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000473 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100474 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200476 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000477 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --no-force) FORCE=0;;
479 --no-keep-going) KEEP_GOING=0;;
480 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200481 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100482 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200486 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200488 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200489 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --seed|-s) shift; SEED="$1";;
491 -*)
492 echo >&2 "Unknown option: $1"
493 echo >&2 "Run $0 --help for usage."
494 exit 120
495 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000496 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 esac
498 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100499 done
SimonB2e23c822016-04-16 21:54:39 +0100500
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100501 # Exclude components that are not supported on this platform.
502 SUPPORTED_COMPONENTS=
503 for component in $ALL_COMPONENTS; do
504 case $(type "support_$component" 2>&1) in
505 *' function'*)
506 if ! support_$component; then continue; fi;;
507 esac
508 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
509 done
510
511 if [ $list_components -eq 1 ]; then
512 printf '%s\n' $SUPPORTED_COMPONENTS
513 exit
514 fi
515
Gilles Peskinea28db922019-01-10 00:05:18 +0100516 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200517 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000518 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100519 fi
520
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000521 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
522 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100523 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100525 fi
SimonB2e23c822016-04-16 21:54:39 +0100526
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200527 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 if [ $all_except -eq 0 ]; then
529 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200530 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
531 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200532 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200534 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200535 # If the requested name includes a wildcard character, don't
536 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100537 case $component in
538 *[*?\[]*) continue;;
539 esac
540 case " $SUPPORTED_COMPONENTS " in
541 *" $component "*) :;;
542 *)
543 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
544 unsupported=$((unsupported + 1));;
545 esac
546 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200547 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100548 if [ $unsupported -ne 0 ]; then
549 exit 2
550 fi
551 fi
552
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000553 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100554 RUN_COMPONENTS=
555 for component in $SUPPORTED_COMPONENTS; do
556 if is_component_included "$component"; [ $? -eq $all_except ]; then
557 RUN_COMPONENTS="$RUN_COMPONENTS $component"
558 fi
559 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560
561 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000562 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100563}
SimonB2e23c822016-04-16 21:54:39 +0100564
Gilles Peskine8f073122018-11-27 15:58:47 +0100565pre_check_git () {
566 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100567 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 git checkout-index -f -q $CONFIG_H
569 cleanup
570 else
SimonB2e23c822016-04-16 21:54:39 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
573 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
574 echo "You can either delete this directory manually, or force the test by rerunning"
575 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
576 exit 1
577 fi
578
Ronald Cron7a93ac52023-07-20 09:49:12 +0200579 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100580 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100581 echo "You can either delete or preserve your work, or force the test by rerunning the"
582 echo "script as: $0 --force"
583 exit 1
584 fi
SimonB2e23c822016-04-16 21:54:39 +0100585 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500586}
587
Gilles Peskine568f53a2021-07-12 18:16:01 +0200588pre_restore_files () {
589 # If the makefiles have been generated by a framework such as cmake,
590 # restore them from git. If the makefiles look like modifications from
591 # the ones checked into git, take care not to modify them. Whatever
592 # this function leaves behind is what the script will restore before
593 # each component.
594 case "$(head -n1 Makefile)" in
595 *[Gg]enerated*)
596 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
597 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
598 ;;
599 esac
600}
601
Gilles Peskinef83eb822020-03-30 20:11:39 +0200602pre_back_up () {
603 for x in $files_to_back_up; do
604 cp -p "$x" "$x$backup_suffix"
605 done
606}
607
Gilles Peskine8f073122018-11-27 15:58:47 +0100608pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100609 failure_count=0 # Number of failed components
610 last_failure_status=0 # Last failure status in this component
611
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100612 # See err_trap
613 previous_failure_status=0
614 previous_failed_command=
615 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100616 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100617
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 start_red=
619 end_color=
620 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100621 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100622 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
623 start_red=$(printf '\033[31m')
624 end_color=$(printf '\033[0m')
625 ;;
626 esac
627 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100628
629 # Keep a summary of failures in a file. We'll print it out at the end.
630 failure_summary_file=$PWD/all-sh-failures-$$.log
631 : >"$failure_summary_file"
632
633 # Whether it makes sense to keep a component going after the specified
634 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200635 # This function normally receives the failing simple command
636 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
637 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200639 # False positives result in running things that can't be expected to
640 # work. False negatives result in things not running after something else
641 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100642 can_keep_going_after_failure () {
643 case "$1" in
644 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200645 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100646 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200647 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
648 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
649 *make*check*) true;;
650 "grep "*) true;;
651 "[ "*) true;;
652 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100653 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100654 esac
655 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100656
657 # This function runs if there is any error in a component.
658 # It must either exit with a nonzero status, or set
659 # last_failure_status to a nonzero value.
660 err_trap () {
661 # Save $? (status of the failing command). This must be the very
662 # first thing, before $? is overridden.
663 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100664 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100665
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100666 if [[ $last_failure_status -eq $previous_failure_status &&
667 "$failed_command" == "$previous_failed_command" &&
668 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
669 then
670 # The same command failed twice in a row, but this time one level
671 # less deep in the function call stack. This happens when the last
672 # command of a function returns a nonzero status, and the function
673 # returns that same status. Ignore the second failure.
674 previous_failure_funcall_depth=${#FUNCNAME[@]}
675 return
676 fi
677 previous_failure_status=$last_failure_status
678 previous_failed_command=$failed_command
679 previous_failure_funcall_depth=${#FUNCNAME[@]}
680
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 text="$current_section: $failed_command -> $last_failure_status"
682 echo "${start_red}^^^^$text^^^^${end_color}" >&2
683 echo "$text" >>"$failure_summary_file"
684
685 # If the command is fatal (configure or build command), stop this
686 # component. Otherwise (test command) keep the component running
687 # (run more tests from the same build).
688 if ! can_keep_going_after_failure "$failed_command"; then
689 exit $last_failure_status
690 fi
691 }
692
Gilles Peskine7c652162017-12-11 00:01:40 +0100693 final_report () {
694 if [ $failure_count -gt 0 ]; then
695 echo
696 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100697 echo "${start_red}FAILED: $failure_count components${end_color}"
698 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
700 elif [ -z "${1-}" ]; then
701 echo "SUCCESS :)"
702 fi
703 if [ -n "${1-}" ]; then
704 echo "Killed by SIG$1."
705 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 rm -f "$failure_summary_file"
707 if [ $failure_count -gt 0 ]; then
708 exit 1
709 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100710 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100711}
712
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200713# record_status() and if_build_succeeded() are kept temporarily for backward
714# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100715record_status () {
716 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100717}
Gilles Peskine7c652162017-12-11 00:01:40 +0100718if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
721
Gilles Peskinea681c592020-03-28 21:27:40 +0100722# '! true' does not trigger the ERR trap. Arrange to trigger it, with
723# a reasonably informative error message (not just "$@").
724not () {
725 if "$@"; then
726 report_failed_command="! $*"
727 false
728 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200729 fi
730}
731
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200732pre_prepare_outcome_file () {
733 case "$MBEDTLS_TEST_OUTCOME_FILE" in
734 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
735 esac
736 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
737 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
738 fi
739}
740
Gilles Peskine8f073122018-11-27 15:58:47 +0100741pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200742 if [ $QUIET -eq 1 ]; then
743 return
744 fi
745
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 msg "info: $0 configuration"
747 echo "MEMORY: $MEMORY"
748 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200749 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100750 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100751 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
754 echo "GNUTLS_CLI: $GNUTLS_CLI"
755 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
757 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
758}
Andres AG7770ea82016-10-10 15:46:20 +0100759
Andres AGd9eba4b2016-08-26 14:42:14 +0100760# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100761pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000762 # Build the list of variables to pass to output_env.sh.
763 set env
SimonB2e23c822016-04-16 21:54:39 +0100764
Gilles Peskine87964262019-01-06 22:40:00 +0000765 case " $RUN_COMPONENTS " in
766 # Require OpenSSL and GnuTLS if running any tests (as opposed to
767 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
768 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100769 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000770 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
771 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100772 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000773 export GNUTLS_CLI="$GNUTLS_CLI"
774 export GNUTLS_SERV="$GNUTLS_SERV"
775 # Avoid passing --seed flag in every call to ssl-opt.sh
776 if [ -n "${SEED-}" ]; then
777 export SEED
778 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200779 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000780 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200781 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
782 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000783 ;;
784 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
787 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200791 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000792 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
796 esac
797
798 case " $RUN_COMPONENTS " in
799 *" test_zeroize "*) check_tools "gdb";;
800 esac
801
802 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000803 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000804 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
805 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200806 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
808 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
810 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
811 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000812 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000813
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200814 # past this point, no call to check_tool, only printing output
815 if [ $QUIET -eq 1 ]; then
816 return
817 fi
818
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000819 msg "info: output_env.sh"
820 case $RUN_COMPONENTS in
821 *_armcc*)
822 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
823 *) set "$@" RUN_ARMCC=0;;
824 esac
825 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100826}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100827
Gilles Peskine1570b592021-04-22 01:10:12 +0200828pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200829 # since make doesn't have proper dependencies, remove any possibly outdate
830 # file that might be around before generating fresh ones
831 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200832 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200833 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200834 else
835 make generated_files
836 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200837}
838
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000839clang_version() {
840 if command -v clang > /dev/null ; then
841 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
842 else
843 echo 0 # report version 0 for "no clang"
844 fi
845}
846
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200847################################################################
848#### Helpers for components using libtestdriver1
849################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100850
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200851# How to use libtestdriver1
852# -------------------------
853#
854# 1. Define the list algorithms and key types to accelerate,
855# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
856# Examples:
857# - loc_accel_list="ALG_JPAKE"
858# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200859# 2. Make configurations changes for the driver and/or main libraries.
860# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
861# can be either "default" to start with the default config, or a name
862# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200863# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200864# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
865# These changes affect both the driver and the main libraries.
866# (Note: they need to have the same set of PSA_WANT symbols, as that
867# determines the ABI between them.)
868# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
869# main libraries. Typically, you want to disable the module(s) that are
870# being accelerated. You may need to also disable modules that depend
871# on them or options that are not supported with drivers.
872# 2d. On top of psa/crypto_config.h, the driver library uses its own config
873# file: tests/include/test/drivers/config_test_driver.h. You usually
874# don't need to edit it: using loc_extra_list (see below) is preferred.
875# However, when there's no PSA symbol for what you want to enable,
876# calling scripts/config.py on this file remains the only option.
877# 3. Build the driver library, then the main libraries, test, and programs.
878# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
879# need to enable more algorithms here, typically hash algorithms when
880# accelerating some signature algorithms (ECDSA, RSAv2). This is done
881# by passing a 2nd argument listing the extra algorithms.
882# Example:
883# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
884# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800885# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200886# additional arguments will be passed to make: this can be useful if
887# you don't want to build everything when iterating during development.
888# Example:
889# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
890# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200891
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200892# Adjust the configuration - for both libtestdriver1 and main library,
893# as they should have the same PSA_WANT macros.
894helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200895 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200896 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200897 if [ "$base_config" != "default" ]; then
898 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 fi
900
901 # Enable PSA-based config (necessary to use drivers)
902 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
903
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200904 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
905 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
906 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000907
908 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
909 # otherwise we will end up running multithreaded tests without mutexes to protect them.
910 if scripts/config.py get MBEDTLS_THREADING_C; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
912 fi
913
914 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
915 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
916 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200917}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100918
Valerio Settib2fd6732023-08-15 17:10:47 +0200919# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200920# The function optionally accepts 1 parameter: a space-separated list of the
921# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200922helper_disable_builtin_curves() {
923 allowed_list="${1:-}"
924 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
925
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200926 for curve in $allowed_list; do
927 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200928 done
929}
930
931# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
932# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
933# in the following helpers.
934helper_get_psa_curve_list () {
935 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200936 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
937 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200938 done
939
940 echo "$loc_list"
941}
942
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100943# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
944# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
945# in the following helpers.
946helper_get_psa_dh_group_list () {
947 loc_list=""
948 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
949 loc_list="$loc_list $item"
950 done
951
952 echo "$loc_list"
953}
954
Valerio Settib2fd6732023-08-15 17:10:47 +0200955# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200956# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200957# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200958helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200959 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200960 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200961 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 +0200962 # Skip DERIVE for elliptic keys since there is no driver dispatch for
963 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200964 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
965 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200966 fi
967 done
968
969 echo "$loc_list"
970}
971
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200972# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200973#
974# Parameters:
975# 1. a space-separated list of things to accelerate;
976# 2. optional: a space-separate list of things to also support.
977# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
978helper_libtestdriver1_make_drivers() {
979 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100980 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200981}
982
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200983# Build the main libraries, programs and tests,
984# linking to the drivers library (with ASan).
985#
986# Parameters:
987# 1. a space-separated list of things to accelerate;
988# *. remaining arguments if any are passed directly to make
989# (examples: lib, -C tests test_suite_xxx, etc.)
990# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
991helper_libtestdriver1_make_main() {
992 loc_accel_list=$1
993 shift
994
995 # we need flags both with and without the LIBTESTDRIVER1_ prefix
996 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
997 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100998 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200999}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001000
1001################################################################
1002#### Basic checks
1003################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001004
1005#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001006# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001007#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001008# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001009# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001010# 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 +02001011# time, so start with a GCC build).
1012# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001013#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001014# Indicative running times are given for reference.
1015
Gilles Peskine8f073122018-11-27 15:58:47 +01001016component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001017 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001018 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001019}
Janos Follathb72c6782016-07-19 14:54:17 +01001020
Gilles Peskine67debb62021-05-18 16:09:50 +02001021component_check_generated_files () {
1022 msg "Check: check-generated-files, files generated with make" # 2s
1023 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001024 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001025
1026 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001027 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001028 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001029 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001030
1031 msg "Check: check-generated-files -u, files absent" # 2s
1032 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001033 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001034 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001035 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001036
1037 # This component ends with the generated files present in the source tree.
1038 # This is necessary for subsequent components!
1039}
1040
Gilles Peskine8f073122018-11-27 15:58:47 +01001041component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001042 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001043 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001044}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001045
Gilles Peskine8f073122018-11-27 15:58:47 +01001046component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001047 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001048 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001049}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001050
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001051component_check_changelog () {
1052 msg "Check: changelog entries" # < 1s
1053 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001054 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001055 if [ -e ChangeLog.new ]; then
1056 # Show the diff for information. It isn't an error if the diff is
1057 # non-empty.
1058 diff -u ChangeLog ChangeLog.new || true
1059 rm ChangeLog.new
1060 fi
1061}
1062
Gilles Peskine8f073122018-11-27 15:58:47 +01001063component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001064 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001065 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001066}
Darryl Greena07039c2018-03-13 16:48:16 +00001067
Gilles Peskine895868b2019-09-19 21:30:05 +02001068component_check_test_cases () {
1069 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001070 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001071 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001072 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001073 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001074 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001075 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001076 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001077}
1078
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001079component_check_test_dependencies () {
1080 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001081 # The purpose of this component is to catch unjustified dependencies on
1082 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1083 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1084 # MBEDTLS_PSA_xxx).
1085 #
1086 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1087 # this component is meant to catch. However a few of them are justified,
1088 # mostly by the absence of a PSA equivalent, so this component includes a
1089 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001090
1091 found="check-test-deps-found-$$"
1092 expected="check-test-deps-expected-$$"
1093
1094 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001095 grep 'depends_on' \
1096 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001097 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001098 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001099 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001100
Yanray Wang18040ed2023-11-23 21:29:56 +08001101 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001102 rm -f $expected
1103 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1104 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001105 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1106 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001107 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1108 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001109 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1110 # the test code and that's probably the most convenient way of achieving
1111 # the test's goal.
1112 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1113 # No PSA equivalent - we should probably have one in the future.
1114 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1115 # No PSA equivalent - needed by some init tests
1116 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001117 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001118 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001119
1120 # Compare reality with expectation.
1121 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001122 #
1123 # The output should be empty. When it's not:
1124 # - Each '+' line is a macro that was found but not expected. You want to
1125 # find where that macro occurs, and either replace it with PSA macros, or
1126 # add it to the exceptions list above with a justification.
1127 # - Each '-' line is a macro that was expected but not found; it means the
1128 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001129 diff -U0 $expected $found
1130
1131 rm $found $expected
1132}
1133
Gilles Peskine8f073122018-11-27 15:58:47 +01001134component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001135 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001136 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001137}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001138
Gilles Peskine192c72f2017-12-21 15:59:21 +01001139
Gilles Peskine636c26a2020-03-04 20:46:15 +01001140
Gilles Peskine192c72f2017-12-21 15:59:21 +01001141################################################################
1142#### Build and test many configurations and targets
1143################################################################
1144
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001145component_test_default_out_of_box () {
1146 msg "build: make, default config (out-of-box)" # ~1min
1147 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001148 # Disable fancy stuff
1149 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001150
1151 msg "test: main suites make, default config (out-of-box)" # ~10s
1152 make test
1153
1154 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001155 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001156
1157 msg "program demos: make, default config (out-of-box)" # ~10s
1158 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001159}
1160
Gilles Peskine8f073122018-11-27 15:58:47 +01001161component_test_default_cmake_gcc_asan () {
1162 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001163 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1164 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001165
Gilles Peskine8f073122018-11-27 15:58:47 +01001166 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1167 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001168
Gilles Peskine82b27272019-06-14 18:27:03 +02001169 msg "program demos (ASan build)" # ~10s
1170 tests/scripts/run_demos.py
1171
Gilles Peskine97bea012020-04-23 23:37:45 +02001172 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001173 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001174
Gilles Peskine6848d172023-11-02 19:58:03 +01001175 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001176 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001177
Gilles Peskine8f073122018-11-27 15:58:47 +01001178 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001179 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001180
Gilles Peskine8f073122018-11-27 15:58:47 +01001181 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001182 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001183
1184 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001185 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001186}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001187
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001188component_test_default_cmake_gcc_asan_new_bignum () {
1189 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001190 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001191 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001192 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001193
1194 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1195 make test
1196
1197 msg "test: selftest (ASan build)" # ~ 10s
1198 programs/test/selftest
1199
1200 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1201 tests/ssl-opt.sh
1202
1203 msg "test: compat.sh (ASan build)" # ~ 6 min
1204 tests/compat.sh
1205
1206 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1207 tests/context-info.sh
1208}
1209
Hanno Becker01635512019-02-26 14:27:09 +00001210component_test_full_cmake_gcc_asan () {
1211 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001212 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001213 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1214 make
1215
1216 msg "test: main suites (inc. selftests) (full config, ASan build)"
1217 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001218
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001219 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001220 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001221
Gilles Peskine636c26a2020-03-04 20:46:15 +01001222 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001223 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001224
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001225 # Note: the next two invocations cover all compat.sh test cases.
1226 # We should use the same here and in basic-build-test.sh.
1227 msg "test: compat.sh: default version (full config, ASan build)"
1228 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnarde7987b62024-04-17 12:30:05 +02001229
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001230 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1231 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001232
1233 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001234 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001235}
1236
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001237
1238component_test_full_cmake_gcc_asan_new_bignum () {
1239 msg "build: full config, cmake, gcc, ASan"
1240 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001241 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001242 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001243 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001244
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001245 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001246 make test
1247
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001248 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001249 programs/test/selftest
1250
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001251 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001252 tests/ssl-opt.sh
1253
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001254 # Note: the next two invocations cover all compat.sh test cases.
1255 # We should use the same here and in basic-build-test.sh.
1256 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1257 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001258
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001259 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1260 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001261
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001262 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001263 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001264}
1265
Ronald Cronc3623db2020-10-29 10:51:32 +01001266component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001267 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001268 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001269 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1270 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1271 make
1272
1273 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1274 make test
1275}
1276
David Horstmann4a48bec2024-03-13 15:42:31 +00001277component_test_psa_assume_exclusive_buffers () {
1278 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001279 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001280 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001281 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1282 make
1283
David Horstmann4a48bec2024-03-13 15:42:31 +00001284 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001285 make test
1286}
1287
Gilles Peskinea3548672021-06-17 11:37:52 +02001288# check_renamed_symbols HEADER LIB
1289# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1290# name is LIB.
1291check_renamed_symbols () {
1292 ! nm "$2" | sed 's/.* //' |
1293 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1294}
1295
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001296component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001297 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001298 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001299 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1300 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1301 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1302 # We can only compile, not link, since our test and sample programs
1303 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1304 # is active.
1305 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001306
1307 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1308 # version is not present.
1309 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001310 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001311}
1312
Valerio Setti63097752024-03-12 13:18:13 +01001313# Get a list of library-wise undefined symbols and ensure that they only
1314# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1315# This function is a common helper used by both:
1316# - component_test_default_psa_crypto_client_without_crypto_provider
1317# - component_build_full_psa_crypto_client_without_crypto_provider.
1318common_check_mbedtls_missing_symbols() {
1319 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1320 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1321 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1322 not grep mbedtls_ linking_errors.txt
1323
1324 rm sym_def.txt sym_undef.txt linking_errors.txt
1325}
1326
1327component_test_default_psa_crypto_client_without_crypto_provider () {
1328 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1329
Ronald Cron336678b2021-01-28 17:54:24 +01001330 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1331 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001332 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001333 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001334 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001335 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001336
Ronald Cron336678b2021-01-28 17:54:24 +01001337 make
1338
Valerio Setti63097752024-03-12 13:18:13 +01001339 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1340 common_check_mbedtls_missing_symbols
1341
1342 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001343 make test
1344}
1345
Valerio Setti63097752024-03-12 13:18:13 +01001346component_build_full_psa_crypto_client_without_crypto_provider () {
1347 msg "build: full config - PSA_CRYPTO_C"
1348
1349 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1350 scripts/config.py full
1351
1352 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1353 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1354 # Dynamic secure element support is a deprecated feature and it is not
1355 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1356 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1357
1358 # Since there is no crypto provider in this build it is not possible to
1359 # build all the test executables and progrems due to missing PSA functions
1360 # at link time. Therefore we will just build libraries and we'll check
1361 # that symbols of interest are there.
1362 make lib
1363
1364 msg "check missing symbols: full config - PSA_CRYPTO_C"
1365
1366 common_check_mbedtls_missing_symbols
1367
1368 # Ensure that desired functions are included into the build (extend the
1369 # following list as required).
1370 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1371 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1372 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1373}
1374
Jaeden Amero424fa932021-05-14 08:34:32 +01001375component_test_psa_crypto_rsa_no_genprime() {
1376 msg "build: default config minus MBEDTLS_GENPRIME"
1377 scripts/config.py unset MBEDTLS_GENPRIME
1378 make
1379
1380 msg "test: default config minus MBEDTLS_GENPRIME"
1381 make test
1382}
1383
Gilles Peskine782f4112018-11-27 16:11:09 +01001384component_test_ref_configs () {
1385 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001386 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1387 # want to re-generate generated files that depend on it, quite correctly.
1388 # However this doesn't work as the generation script expects a specific
1389 # format for mbedtls_config.h, which the other files don't follow. Also,
1390 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001391 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001392 # whether they're on or off. So, disable cmake's (over-sensitive here)
1393 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001394 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001395 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001396 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001397}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001398
Gilles Peskine8f073122018-11-27 15:58:47 +01001399component_test_no_renegotiation () {
1400 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001401 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001402 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001403 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001404
Gilles Peskine8f073122018-11-27 15:58:47 +01001405 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1406 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001407
Gilles Peskine8f073122018-11-27 15:58:47 +01001408 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001409 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001410}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001411
Gilles Peskine636c26a2020-03-04 20:46:15 +01001412component_test_no_pem_no_fs () {
1413 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1414 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1415 scripts/config.py unset MBEDTLS_FS_IO
1416 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1417 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001418 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001419 make
1420
1421 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1422 make test
1423
1424 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001425 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001426}
1427
Gilles Peskine8f073122018-11-27 15:58:47 +01001428component_test_rsa_no_crt () {
1429 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001430 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001431 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001432 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001433
Gilles Peskine8f073122018-11-27 15:58:47 +01001434 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1435 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001436
Gilles Peskine8f073122018-11-27 15:58:47 +01001437 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001438 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001439
Gilles Peskine8f073122018-11-27 15:58:47 +01001440 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001441 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001442
1443 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001444 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001445}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001446
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001447component_test_no_ctr_drbg_classic () {
1448 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001449 scripts/config.py full
1450 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001451 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001452 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001453
Dave Rodgman17127e92023-12-14 16:42:48 +00001454 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001455 make
1456
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001457 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001458 make test
1459
Gilles Peskineba749042021-01-13 20:02:03 +01001460 # In this configuration, the TLS test programs use HMAC_DRBG.
1461 # The SSL tests are slow, so run a small subset, just enough to get
1462 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001463 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001464 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001465
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001466 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001467 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001468}
1469
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001470component_test_no_ctr_drbg_use_psa () {
1471 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001472 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001473 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1474 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001475
Dave Rodgman17127e92023-12-14 16:42:48 +00001476 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001477 make
1478
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001479 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1480 make test
1481
1482 # In this configuration, the TLS test programs use HMAC_DRBG.
1483 # The SSL tests are slow, so run a small subset, just enough to get
1484 # confidence that the SSL code copes with HMAC_DRBG.
1485 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001486 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001487
1488 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001489 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001490}
1491
1492component_test_no_hmac_drbg_classic () {
1493 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1494 scripts/config.py full
1495 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1496 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1497 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001498 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001499
Dave Rodgman17127e92023-12-14 16:42:48 +00001500 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001501 make
1502
1503 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001504 make test
1505
Gilles Peskinea2224342020-11-19 22:14:34 +01001506 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1507 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1508 # instead.
1509 # Test SSL with non-deterministic ECDSA. Only test features that
1510 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001511 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001512 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001513
1514 # To save time, only test one protocol version, since this part of
1515 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001516 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001517 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001518}
1519
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001520component_test_no_hmac_drbg_use_psa () {
1521 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1522 scripts/config.py full
1523 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1524 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1525 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1526
Dave Rodgman17127e92023-12-14 16:42:48 +00001527 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001528 make
1529
1530 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1531 make test
1532
1533 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1534 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1535 # instead.
1536 # Test SSL with non-deterministic ECDSA. Only test features that
1537 # might be affected by how ECDSA signature is performed.
1538 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001539 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540
1541 # To save time, only test one protocol version, since this part of
1542 # the protocol is identical in (D)TLS up to 1.2.
1543 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001544 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001545}
1546
1547component_test_psa_external_rng_no_drbg_classic () {
1548 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1549 scripts/config.py full
1550 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001551 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001552 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001553 scripts/config.py unset MBEDTLS_ENTROPY_C
1554 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1555 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001556 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1557 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1558 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001559 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1560 # the SSL test programs don't have an RNG and can't work. Explicitly
1561 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001562 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001563
1564 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1565 make test
1566
Gilles Peskine8eb29432021-02-03 20:07:11 +01001567 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001568 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001569}
1570
1571component_test_psa_external_rng_no_drbg_use_psa () {
1572 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001573 scripts/config.py full
1574 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001575 scripts/config.py unset MBEDTLS_ENTROPY_C
1576 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1577 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001578 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1579 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1580 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001581 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001582
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001583 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001584 make test
1585
Gilles Peskine8eb29432021-02-03 20:07:11 +01001586 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001587 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001588}
1589
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001590component_test_psa_external_rng_use_psa_crypto () {
1591 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1592 scripts/config.py full
1593 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1594 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1595 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001596 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001597
1598 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1599 make test
1600
1601 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1602 tests/ssl-opt.sh -f 'Default\|opaque'
1603}
1604
Gilles Peskine801c4332023-04-28 21:04:28 +02001605component_test_psa_inject_entropy () {
1606 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1607 scripts/config.py full
1608 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1609 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1610 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1611 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1612 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1613 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001614 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 +02001615
1616 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1617 make test
1618}
1619
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001620component_test_sw_inet_pton () {
1621 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1622
1623 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1624 scripts/config.py set MBEDTLS_TEST_HOOKS
1625 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1626
1627 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1628 make test
1629}
1630
Valerio Settia41654d2024-02-08 10:33:11 +01001631component_full_no_pkparse_pkwrite() {
1632 msg "build: full without pkparse and pkwrite"
1633
1634 scripts/config.py crypto_full
1635 scripts/config.py unset MBEDTLS_PK_PARSE_C
1636 scripts/config.py unset MBEDTLS_PK_WRITE_C
1637
Valerio Settia41654d2024-02-08 10:33:11 +01001638 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1639
1640 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1641 not grep mbedtls_pk_parse_key library/pkparse.o
1642 not grep mbedtls_pk_write_key_der library/pkwrite.o
1643
1644 msg "test: full without pkparse and pkwrite"
1645 make test
1646}
1647
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001648component_test_crypto_full_md_light_only () {
1649 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001650 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001651 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001652 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001653 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001654 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001655 scripts/config.py unset MBEDTLS_HKDF_C
1656 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001657 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001658 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001659 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001660 # Disable things that would auto-enable MD_C
1661 scripts/config.py unset MBEDTLS_PKCS5_C
1662
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001663 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1664 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001665 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001666
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001667 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001668 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001669 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001670
1671 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001672 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001673}
1674
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001675component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001676 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001677 scripts/config.py full
1678 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001679 # Don't pull in cipher via PSA mechanisms
1680 # (currently ignored anyway because we completely disable PSA)
1681 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001682 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001683 scripts/config.py unset MBEDTLS_CMAC_C
1684 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001685 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001686 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001687 scripts/config.py unset MBEDTLS_SSL_TLS_C
1688 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001689 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001690 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1691 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001692 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001693 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001694 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001695
Valerio Settidf17a102023-10-23 14:14:19 +02001696 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001697 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001698}
1699
Valerio Setti7e710e82023-08-25 09:14:15 +02001700# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001701# - component_test_full_no_cipher_with_psa_crypto
1702# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001703# It accepts 2 input parameters:
1704# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1705# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001706common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001707 USE_CRYPTO_CONFIG="$1"
1708 COMPONENT_DESCRIPTION="$2"
1709
1710 msg "build: $COMPONENT_DESCRIPTION"
1711
1712 scripts/config.py full
1713 scripts/config.py unset MBEDTLS_CIPHER_C
1714
1715 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001716 # The built-in implementation of the following algs/key-types depends
1717 # on CIPHER_C so we disable them.
1718 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1719 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001720 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001721 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1722 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1723 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1724 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1725 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1726 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1727 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Cron7d949ae2024-05-15 18:31:17 +02001728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001729 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001730 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001731 else
1732 # Don't pull in cipher via PSA mechanisms
1733 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001734 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1735 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1736 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001737 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001738 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001739 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001740 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001741
Gilles Peskine21570cf2023-12-22 11:49:50 +01001742 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001743
Valerio Setti7e710e82023-08-25 09:14:15 +02001744 # Ensure that CIPHER_C was not re-enabled
1745 not grep mbedtls_cipher_init library/cipher.o
1746
1747 msg "test: $COMPONENT_DESCRIPTION"
1748 make test
1749}
1750
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001751component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001752 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001753}
1754
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001755component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001756 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001757}
1758
Valerio Settibdfecb62023-11-07 15:37:20 +01001759component_test_full_no_ccm() {
1760 msg "build: full no PSA_WANT_ALG_CCM"
1761
1762 # Full config enables:
1763 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1764 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1765 scripts/config.py full
1766
1767 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1768 # enabled, but not used from TLS since USE_PSA is set.
1769 # This is helpful to ensure that TLS tests below have proper dependencies.
1770 #
1771 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1772 # PSA_WANT_ALG_CCM to be re-enabled.
1773 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1774
Gilles Peskine21570cf2023-12-22 11:49:50 +01001775 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001776
1777 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001778 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001779}
1780
1781component_test_full_no_ccm_star_no_tag() {
1782 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1783
1784 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1785 scripts/config.py full
1786
1787 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1788 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1789 # This basically disables all unauthenticated ciphers on the PSA side, while
1790 # keeping AEADs enabled.
1791 #
1792 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1793 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1794 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1795 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1796 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1797 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1798 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1799 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1800 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1801 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1802
Gilles Peskine21570cf2023-12-22 11:49:50 +01001803 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001804
1805 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001806 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001807
1808 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001809 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001810}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001811
Valerio Settie1655b82023-01-03 15:35:25 +01001812component_test_full_no_bignum () {
1813 msg "build: full minus bignum"
1814 scripts/config.py full
1815 scripts/config.py unset MBEDTLS_BIGNUM_C
1816 # Direct dependencies of bignum
1817 scripts/config.py unset MBEDTLS_ECP_C
1818 scripts/config.py unset MBEDTLS_RSA_C
1819 scripts/config.py unset MBEDTLS_DHM_C
1820 # Direct dependencies of ECP
1821 scripts/config.py unset MBEDTLS_ECDH_C
1822 scripts/config.py unset MBEDTLS_ECDSA_C
1823 scripts/config.py unset MBEDTLS_ECJPAKE_C
1824 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001825 # Disable what auto-enables ECP_LIGHT
1826 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1827 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001828 # Indirect dependencies of ECP
1829 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1830 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1831 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1832 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1833 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1834 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1835 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1836 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1837 # Direct dependencies of DHM
1838 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1839 # Direct dependencies of RSA
1840 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1841 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1842 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1843 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1844 # PK and its dependencies
1845 scripts/config.py unset MBEDTLS_PK_C
1846 scripts/config.py unset MBEDTLS_PK_PARSE_C
1847 scripts/config.py unset MBEDTLS_PK_WRITE_C
1848 scripts/config.py unset MBEDTLS_X509_USE_C
1849 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1850 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1851 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1852 scripts/config.py unset MBEDTLS_X509_CREATE_C
1853 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1854 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1855 scripts/config.py unset MBEDTLS_PKCS7_C
1856 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1857 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1858 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1859
Gilles Peskine21570cf2023-12-22 11:49:50 +01001860 make
Valerio Settie1655b82023-01-03 15:35:25 +01001861
1862 msg "test: full minus bignum"
1863 make test
1864}
1865
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001866component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001867 msg "build: default with only stream cipher"
1868
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001869 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001870 scripts/config.py unset MBEDTLS_GCM_C
1871 scripts/config.py unset MBEDTLS_CCM_C
1872 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001873 #Disable TLS 1.3 (as no AEAD)
1874 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001875 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001876 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001877 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001878 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001879 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1880 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001881 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001882 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001883 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001884
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001885 make
1886
1887 msg "test: default with only stream cipher"
1888 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001889
1890 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001891}
1892
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001893component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001894 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001895
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001896 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001897 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001898 scripts/config.py unset MBEDTLS_GCM_C
1899 scripts/config.py unset MBEDTLS_CCM_C
1900 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001901 #Disable TLS 1.3 (as no AEAD)
1902 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001903 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel9550c052022-09-28 09:51:55 +02001904 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001905 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001906 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001907 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1908 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001909 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001910 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001911 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001912
Przemek Stekiel9550c052022-09-28 09:51:55 +02001913 make
1914
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001915 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001916 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001917
1918 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001919}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001920
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001921component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001922 msg "build: default with only CBC-legacy cipher"
1923
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001924 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001925 scripts/config.py unset MBEDTLS_GCM_C
1926 scripts/config.py unset MBEDTLS_CCM_C
1927 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001928 #Disable TLS 1.3 (as no AEAD)
1929 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001930 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1931 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1932 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001933 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001934 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001935 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001936 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001937 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001938 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001939
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001940 make
1941
1942 msg "test: default with only CBC-legacy cipher"
1943 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001944
1945 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1946 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001947}
1948
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001949component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001950 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001951
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001952 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001953 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001954 scripts/config.py unset MBEDTLS_GCM_C
1955 scripts/config.py unset MBEDTLS_CCM_C
1956 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001957 #Disable TLS 1.3 (as no AEAD)
1958 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001959 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1960 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1961 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001962 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001963 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001964 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001965 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001966 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001967 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001968
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001969 make
1970
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001971 msg "test: default with only CBC-legacy cipher use psa"
1972 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001973
1974 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1975 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001976}
1977
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001978component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001979 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1980
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001981 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001982 scripts/config.py unset MBEDTLS_GCM_C
1983 scripts/config.py unset MBEDTLS_CCM_C
1984 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001985 #Disable TLS 1.3 (as no AEAD)
1986 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001987 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1988 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1989 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1990 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1991 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001992 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001993 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001994 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001995 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001996
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001997 make
1998
1999 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2000 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002001
2002 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2003 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002004}
2005
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002006component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2007 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002008
2009 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002010 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002011 scripts/config.py unset MBEDTLS_GCM_C
2012 scripts/config.py unset MBEDTLS_CCM_C
2013 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002014 #Disable TLS 1.3 (as no AEAD)
2015 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002016 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2017 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2018 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2019 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2020 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002021 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002022 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002023 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002024 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002025
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002026 make
2027
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002028 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002029 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002030
2031 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2032 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002033}
2034
Valerio Setti9f0ec532022-11-08 13:03:24 +01002035# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2036# that we could use for interop testing. However, we now have sort of two
2037# implementations ourselves: one using PSA, the other not. At least test that
2038# these two interoperate with each other.
2039component_test_tls1_2_ecjpake_compatibility() {
2040 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2041 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002042 # Explicitly make lib first to avoid a race condition:
2043 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2044 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002045 make -C programs ssl/ssl_server2 ssl/ssl_client2
2046 cp programs/ssl/ssl_server2 s2_no_use_psa
2047 cp programs/ssl/ssl_client2 c2_no_use_psa
2048
2049 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2050 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2051 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002052 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002053 make -C programs ssl/ssl_server2 ssl/ssl_client2
2054 make -C programs test/udp_proxy test/query_compile_time_config
2055
Valerio Setti70e02902022-12-02 16:21:56 +01002056 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2057 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2058 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2059 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2060 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2061 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2062 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2063 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 +01002064
2065 rm s2_no_use_psa c2_no_use_psa
2066}
2067
Gilles Peskine636c26a2020-03-04 20:46:15 +01002068component_test_everest () {
2069 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2070 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2071 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2072 make
2073
2074 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2075 make test
2076
Gilles Peskine6848d172023-11-02 19:58:03 +01002077 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002078 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002079
Gilles Peskine636c26a2020-03-04 20:46:15 +01002080 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2081 tests/ssl-opt.sh -f ECDH
2082
2083 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2084 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002085 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002086}
2087
Gilles Peskined3beca92020-07-03 00:15:37 +02002088component_test_everest_curve25519_only () {
2089 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002090 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2091 scripts/config.py unset MBEDTLS_ECDSA_C
2092 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2093 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002094 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002095 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002096 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002097 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2098
Dave Rodgman17127e92023-12-14 16:42:48 +00002099 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002100
2101 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2102 make test
2103}
2104
Gilles Peskine8f073122018-11-27 15:58:47 +01002105component_test_small_ssl_out_content_len () {
2106 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002107 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2108 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002109 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002110 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002111
Gilles Peskine8f073122018-11-27 15:58:47 +01002112 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002113 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002114}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002115
Gilles Peskine8f073122018-11-27 15:58:47 +01002116component_test_small_ssl_in_content_len () {
2117 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002118 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2119 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002120 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002121 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002122
Gilles Peskine8f073122018-11-27 15:58:47 +01002123 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002124 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002125}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002126
Gilles Peskine8f073122018-11-27 15:58:47 +01002127component_test_small_ssl_dtls_max_buffering () {
2128 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002129 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002130 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002131 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002132
Gilles Peskine8f073122018-11-27 15:58:47 +01002133 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002134 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 +01002135}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002136
Gilles Peskine8f073122018-11-27 15:58:47 +01002137component_test_small_mbedtls_ssl_dtls_max_buffering () {
2138 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002139 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002140 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002141 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002142
Gilles Peskine8f073122018-11-27 15:58:47 +01002143 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002144 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002145}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002146
Gilles Peskine75cc7712019-09-06 19:47:17 +02002147component_test_psa_collect_statuses () {
2148 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002149 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002150 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002151 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002152 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002153 rm -f tests/statuses.log
2154}
2155
Gilles Peskine8f073122018-11-27 15:58:47 +01002156component_test_full_cmake_clang () {
2157 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002158 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002159 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 +01002160 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002161
k-stachowiak0291cb72019-06-26 15:52:12 +02002162 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002163 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002164
Gilles Peskineda6017c2022-10-30 21:02:40 +01002165 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2166 programs/test/cpp_dummy_build
2167
Gilles Peskine6848d172023-11-02 19:58:03 +01002168 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002169 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002170
Gilles Peskine82b27272019-06-14 18:27:03 +02002171 msg "program demos (full config, clang)" # ~10s
2172 tests/scripts/run_demos.py
2173
k-stachowiak0291cb72019-06-26 15:52:12 +02002174 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002175 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002176
Gilles Peskine8f073122018-11-27 15:58:47 +01002177 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002178 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002179}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002180
Gilles Peskine0c671602022-11-29 16:01:41 +01002181skip_suites_without_constant_flow () {
2182 # Skip the test suites that don't have any constant-flow annotations.
2183 # This will need to be adjusted if we ever start declaring things as
2184 # secret from macros or functions inside tests/include or tests/src.
2185 SKIP_TEST_SUITES=$(
2186 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2187 sed 's/test_suite_//; s/\.function$//' |
2188 tr '\n' ,)
2189 export SKIP_TEST_SUITES
2190}
2191
Dave Rodgman246210e2023-07-31 18:07:44 +01002192skip_all_except_given_suite () {
2193 # Skip all but the given test suite
2194 SKIP_TEST_SUITES=$(
2195 ls -1 tests/suites/test_suite_*.function |
2196 grep -v $1.function |
2197 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2198 tr '\n' ,)
2199 export SKIP_TEST_SUITES
2200}
2201
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002202component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002203 # This tests both (1) accesses to undefined memory, and (2) branches or
2204 # memory access depending on secret values. To distinguish between those:
2205 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2206 # - or alternatively, change the build type to MemSanDbg, which enables
2207 # origin tracking and nicer stack traces (which are useful for debugging
2208 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002209 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2210 scripts/config.py full
2211 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2212 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2213 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2214 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2215 make
2216
2217 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2218 make test
2219}
2220
2221component_test_memsan_constant_flow_psa () {
2222 # This tests both (1) accesses to undefined memory, and (2) branches or
2223 # memory access depending on secret values. To distinguish between those:
2224 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2225 # - or alternatively, change the build type to MemSanDbg, which enables
2226 # origin tracking and nicer stack traces (which are useful for debugging
2227 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002228 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002229 scripts/config.py full
2230 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2231 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2232 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2233 make
2234
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002235 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002236 make test
2237}
2238
Bence Szépkúti0354d042023-12-06 16:14:37 +01002239component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002240 # This tests both (1) everything that valgrind's memcheck usually checks
2241 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2242 # etc.) and (2) branches or memory access depending on secret values,
2243 # which will be reported as uninitialized memory. To distinguish between
2244 # secret and actually uninitialized:
2245 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2246 # - or alternatively, build with debug info and manually run the offending
2247 # test suite with valgrind --track-origins=yes, then check if the origin
2248 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002249 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2250 scripts/config.py full
2251 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2252 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002253 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002254 cmake -D CMAKE_BUILD_TYPE:String=Release .
2255 make
2256
2257 # this only shows a summary of the results (how many of each type)
2258 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002259 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002260 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002261
2262 # Test asm path in constant time module - by default, it will test the plain C
2263 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2264 msg "test: valgrind asm constant_time"
2265 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2266 skip_all_except_given_suite test_suite_constant_time
2267 cmake -D CMAKE_BUILD_TYPE:String=Release .
2268 make clean
2269 make
2270 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002271}
2272
Bence Szépkúti0354d042023-12-06 16:14:37 +01002273component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002274 # This tests both (1) everything that valgrind's memcheck usually checks
2275 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2276 # etc.) and (2) branches or memory access depending on secret values,
2277 # which will be reported as uninitialized memory. To distinguish between
2278 # secret and actually uninitialized:
2279 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2280 # - or alternatively, build with debug info and manually run the offending
2281 # test suite with valgrind --track-origins=yes, then check if the origin
2282 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002283 msg "build: cmake release GCC, full config with constant flow testing"
2284 scripts/config.py full
2285 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002286 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002287 cmake -D CMAKE_BUILD_TYPE:String=Release .
2288 make
2289
2290 # this only shows a summary of the results (how many of each type)
2291 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002292 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002293 make memcheck
2294}
2295
Janos Follath9338cac2023-10-04 18:55:39 +01002296component_test_tsan () {
2297 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002298 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002299 scripts/config.py set MBEDTLS_THREADING_C
2300 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002301 # Self-tests do not currently use multiple threads.
2302 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002303
Ryan6caf84f2024-03-05 13:57:00 +00002304 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2305 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2306
Janos Follath9338cac2023-10-04 18:55:39 +01002307 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2308 make
2309
2310 msg "test: main suites (TSan)"
2311 make test
2312}
2313
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002314component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002315 # Test that removing the deprecated features from the default
2316 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002317 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2318 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002319 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002320
2321 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2322 make test
2323}
2324
2325component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002326 msg "build: make, full_no_deprecated config" # ~ 30s
2327 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002328 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002329
Gilles Peskine30de2e82020-04-20 21:39:22 +02002330 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002331 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002332
2333 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2334 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002335}
2336
Gilles Peskine8386ea22020-04-30 09:07:29 +02002337component_test_full_no_deprecated_deprecated_warning () {
2338 # Test that there is nothing deprecated in "full_no_deprecated".
2339 # A deprecated feature would trigger a warning (made fatal) from
2340 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002341 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2342 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002343 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2344 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002345 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002346
Gilles Peskine30de2e82020-04-20 21:39:22 +02002347 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002348 make test
2349}
2350
Gilles Peskine8386ea22020-04-30 09:07:29 +02002351component_test_full_deprecated_warning () {
2352 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2353 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002354 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002355 scripts/config.py full
2356 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002357 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002358 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2359 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002360 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002361
Gilles Peskine8386ea22020-04-30 09:07:29 +02002362 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2363 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2364 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002365 # Expect warnings from '#warning' directives in check_config.h and
2366 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002367 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 +01002368
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002369 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2370 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002371
2372 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2373 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002374}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002375
Gilles Peskineec541fe2020-01-31 14:24:14 +01002376# Check that the specified libraries exist and are empty.
2377are_empty_libraries () {
2378 nm "$@" >/dev/null 2>/dev/null
2379 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2380}
2381
2382component_build_crypto_default () {
2383 msg "build: make, crypto only"
2384 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002385 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002386 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002387}
2388
2389component_build_crypto_full () {
2390 msg "build: make, crypto only, full config"
2391 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002392 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002393 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002394}
2395
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002396component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002397 msg "build: make, config for PSA crypto service"
2398 scripts/config.py crypto
2399 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2400 # Disable things that are not needed for just cryptography, to
2401 # reach a configuration that would be typical for a PSA cryptography
2402 # service providing all implemented PSA algorithms.
2403 # System stuff
2404 scripts/config.py unset MBEDTLS_ERROR_C
2405 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002406 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002407 # Crypto stuff with no PSA interface
2408 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002409 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002410 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002411 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002412 scripts/config.py unset MBEDTLS_NIST_KW_C
2413 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2414 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2415 scripts/config.py unset MBEDTLS_PKCS12_C
2416 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002417 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2418 # in PSA code to work with RSA keys. We don't require users to set those:
2419 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002420 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002421 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002422 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002423 make CFLAGS='-O1 -Werror' all test
2424 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2425}
2426
Gilles Peskineec541fe2020-01-31 14:24:14 +01002427component_build_crypto_baremetal () {
2428 msg "build: make, crypto only, baremetal config"
2429 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002430 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002431 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002432}
Daniel Axtens446af202020-09-02 21:30:13 +10002433support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002434 support_build_baremetal "$@"
2435}
2436
2437component_build_baremetal () {
2438 msg "build: make, baremetal config"
2439 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002440 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002441}
2442support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002443 # Older Glibc versions include time.h from other headers such as stdlib.h,
2444 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2445 # problem, Ubuntu 18.04 is ok.
2446 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2447}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002448
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002449# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002450component_test_depends_py_cipher_id () {
2451 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002452 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002453}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002454
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002455component_test_depends_py_cipher_chaining () {
2456 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002457 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002458}
2459
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002460component_test_depends_py_cipher_padding () {
2461 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002462 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002463}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002464
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002465component_test_depends_py_curves () {
2466 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002467 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002468}
2469
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002470component_test_depends_py_hashes () {
2471 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002472 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002473}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002474
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002475component_test_depends_py_kex () {
2476 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002477 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002478}
2479
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002480component_test_depends_py_pkalgs () {
2481 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002482 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002483}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002484
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002485# PSA equivalents of the depends.py tests
2486component_test_depends_py_cipher_id_psa () {
2487 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002488 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002489}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002490
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002491component_test_depends_py_cipher_chaining_psa () {
2492 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002493 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002494}
2495
2496component_test_depends_py_cipher_padding_psa () {
2497 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002498 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002499}
2500
2501component_test_depends_py_curves_psa () {
2502 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002503 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002504}
2505
2506component_test_depends_py_hashes_psa () {
2507 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002508 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002509}
2510
2511component_test_depends_py_kex_psa () {
2512 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002513 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002514}
2515
2516component_test_depends_py_pkalgs_psa () {
2517 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002518 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002519}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002520
Valerio Setti6bed64e2024-01-17 15:21:44 +01002521component_test_psa_crypto_config_ffdh_2048_only () {
2522 msg "build: full config - only DH 2048"
2523
2524 scripts/config.py full
2525
2526 # Disable all DH groups other than 2048.
2527 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2528 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2529 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2530 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2531
2532 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2533
2534 msg "test: full config - only DH 2048"
2535 make test
2536
2537 msg "ssl-opt: full config - only DH 2048"
2538 tests/ssl-opt.sh -f "ffdh"
2539}
2540
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002541component_build_no_pk_rsa_alt_support () {
2542 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2543
2544 scripts/config.py full
2545 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2546 scripts/config.py set MBEDTLS_RSA_C
2547 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2548
2549 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002550 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002551}
2552
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002553component_build_module_alt () {
2554 msg "build: MBEDTLS_XXX_ALT" # ~30s
2555 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002556
2557 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002558 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2559 scripts/config.py unset MBEDTLS_AESNI_C
2560 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002561 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002562 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2563 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002564 # You can only have one threading implementation: alt or pthread, not both.
2565 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002566 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2567 # directly and assumes the implementation works with partial groups.
2568 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002569 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2570 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2571 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002572 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2573 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2574 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002575
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002576 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2577 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2578 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002579 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002580
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002581 # We can only compile, not link, since we don't have any implementations
2582 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002583 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002584}
2585
2586component_build_dhm_alt () {
2587 msg "build: MBEDTLS_DHM_ALT" # ~30s
2588 scripts/config.py full
2589 scripts/config.py set MBEDTLS_DHM_ALT
2590 # debug.c currently references mbedtls_dhm_context fields directly.
2591 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002592 # We can only compile, not link, since we don't have any implementations
2593 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002594 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002595}
2596
Gilles Peskine64996c32024-01-23 20:25:47 +01002597component_test_no_psa_crypto_full_cmake_asan() {
2598 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2599 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002600 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002601 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002602 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002603 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002604 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002605 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002606 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002607 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002608 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002609 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002610 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002611 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002612
Gilles Peskine64996c32024-01-23 20:25:47 +01002613 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002614 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002615
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002616 # Note: ssl-opt.sh has some test cases that depend on
2617 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2618 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002619 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002620 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002621
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02002622 # Note: the next two invocations cover all compat.sh test cases.
2623 # We should use the same here and in basic-build-test.sh.
2624 msg "test: compat.sh: default version (full minus PSA crypto)"
2625 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002626
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02002627 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002628 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002629}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002630
Ronald Cron403c15c2021-09-13 09:38:05 +02002631component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002632 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002633
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002634 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002635 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002636 $(helper_get_psa_key_type_list "ECC") \
2637 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002638
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002639 # Configure
2640 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002641
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002642 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002643 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002644
2645 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002646 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002647
2648 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002649 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2650 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2651
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002652 # Build
2653 # -----
2654
2655 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002656 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2657 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002658
2659 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2660
Valerio Setti3fe105b2023-10-30 11:08:12 +01002661 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002662
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002663 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002664 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002665
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002666 # Run the tests
2667 # -------------
2668
Ronald Cron403c15c2021-09-13 09:38:05 +02002669 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2670 make test
2671}
2672
Valerio Setti44b178c2023-03-22 14:02:57 +01002673component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002674 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002675
2676 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002677 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002678 $(helper_get_psa_key_type_list "ECC") \
2679 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002680
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002681 # Configure
2682 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002683
Ronald Cron46ac0652024-03-18 12:39:04 +01002684 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002685 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002686
Valerio Setti44b178c2023-03-22 14:02:57 +01002687 # Disable the module that's accelerated
2688 scripts/config.py unset MBEDTLS_ECDH_C
2689
2690 # Disable things that depend on it
2691 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2692 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2693 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2694 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2695 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2696
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002697 # Build
2698 # -----
2699
2700 helper_libtestdriver1_make_drivers "$loc_accel_list"
2701
Valerio Setti3fe105b2023-10-30 11:08:12 +01002702 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002703
Valerio Setti44b178c2023-03-22 14:02:57 +01002704 # Make sure this was not re-enabled by accident (additive config)
2705 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002706
2707 # Run the tests
2708 # -------------
2709
Valerio Setti44b178c2023-03-22 14:02:57 +01002710 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002711 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002712}
2713
Przemek Stekieldccb2022023-05-11 10:48:50 +02002714component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002715 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002716
2717 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002718 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002719 $(helper_get_psa_key_type_list "DH") \
2720 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002721
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002722 # Configure
2723 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002724
Przemek Stekiel565353e2023-07-05 11:07:07 +02002725 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002726 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002727
2728 # Disable the module that's accelerated
2729 scripts/config.py unset MBEDTLS_DHM_C
2730
2731 # Disable things that depend on it
2732 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2733 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2734
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002735 # Build
2736 # -----
2737
2738 helper_libtestdriver1_make_drivers "$loc_accel_list"
2739
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002740 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002741
2742 # Make sure this was not re-enabled by accident (additive config)
2743 not grep mbedtls_dhm_ library/dhm.o
2744
2745 # Run the tests
2746 # -------------
2747
Gilles Peskine14302ed2023-07-19 19:30:04 +02002748 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002749 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002750
Gilles Peskine14302ed2023-07-19 19:30:04 +02002751 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002752 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002753}
2754
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002755component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002756 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002757
2758 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002759 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002760
2761 # Disable things that are not supported
2762 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2763 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002764 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002765
Gilles Peskine14302ed2023-07-19 19:30:04 +02002766 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002767 make test
2768
Gilles Peskine14302ed2023-07-19 19:30:04 +02002769 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002770 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002771}
2772
Valerio Setti44b178c2023-03-22 14:02:57 +01002773component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002774 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002775
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002776 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002777 $(helper_get_psa_key_type_list "ECC") \
2778 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002779
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002780 # Configure
2781 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002782
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002783 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002784
2785 # Make built-in fallback not available
2786 scripts/config.py unset MBEDTLS_ECJPAKE_C
2787 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2788
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002789 # Build
2790 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002791
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002792 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002793
Valerio Setti3fe105b2023-10-30 11:08:12 +01002794 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002795
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002796 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002797 not grep mbedtls_ecjpake_init library/ecjpake.o
2798
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002799 # Run the tests
2800 # -------------
2801
Gilles Peskine14302ed2023-07-19 19:30:04 +02002802 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002803 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002804}
2805
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002806component_test_psa_crypto_config_accel_ecc_some_key_types () {
2807 msg "build: full with accelerated EC algs and some key types"
2808
2809 # Algorithms and key types to accelerate
2810 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2811 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2812 ALG_ECDH \
2813 ALG_JPAKE \
2814 KEY_TYPE_ECC_PUBLIC_KEY \
2815 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2816 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002817 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2818 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002819
2820 # Configure
2821 # ---------
2822
2823 # start with config full for maximum coverage (also enables USE_PSA)
2824 helper_libtestdriver1_adjust_config "full"
2825
2826 # Disable modules that are accelerated - some will be re-enabled
2827 scripts/config.py unset MBEDTLS_ECDSA_C
2828 scripts/config.py unset MBEDTLS_ECDH_C
2829 scripts/config.py unset MBEDTLS_ECJPAKE_C
2830 scripts/config.py unset MBEDTLS_ECP_C
2831
2832 # Disable all curves - those that aren't accelerated should be re-enabled
2833 helper_disable_builtin_curves
2834
2835 # Restartable feature is not yet supported by PSA. Once it will in
2836 # the future, the following line could be removed (see issues
2837 # 6061, 6332 and following ones)
2838 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2839
2840 # this is not supported by the driver API yet
2841 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2842
2843 # Build
2844 # -----
2845
2846 # These hashes are needed for some ECDSA signature tests.
2847 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2848 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2849 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2850
Valerio Setti3fe105b2023-10-30 11:08:12 +01002851 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002852
2853 # ECP should be re-enabled but not the others
2854 not grep mbedtls_ecdh_ library/ecdh.o
2855 not grep mbedtls_ecdsa library/ecdsa.o
2856 not grep mbedtls_ecjpake library/ecjpake.o
2857 grep mbedtls_ecp library/ecp.o
2858
2859 # Run the tests
2860 # -------------
2861
2862 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002863 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002864}
2865
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002866# Run tests with only (non-)Weierstrass accelerated
2867# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002868# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2869# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002870common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002871 weierstrass=$1
2872 if [ $weierstrass -eq 1 ]; then
2873 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002874 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002875 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002876 fi
2877
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002878 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002879
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002880 # Note: Curves are handled in a special way by the libtestdriver machinery,
2881 # so we only want to include them in the accel list when building the main
2882 # libraries, hence the use of a separate variable.
2883 # Note: the following loop is a modified version of
2884 # helper_get_psa_curve_list that only keeps Weierstrass families.
2885 loc_weierstrass_list=""
2886 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002887 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2888 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002889 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002890 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002891 ;;
2892 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002893 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002894 ;;
2895 esac
2896 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002897 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002898 loc_curve_list=$loc_weierstrass_list
2899 else
2900 loc_curve_list=$loc_non_weierstrass_list
2901 fi
2902
Valerio Setti3fe105b2023-10-30 11:08:12 +01002903 # Algorithms and key types to accelerate
2904 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2905 ALG_ECDH \
2906 ALG_JPAKE \
2907 $(helper_get_psa_key_type_list "ECC") \
2908 $loc_curve_list"
2909
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002910 # Configure
2911 # ---------
2912
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002913 # Start with config crypto_full and remove PK_C:
2914 # that's what's supported now, see docs/driver-only-builds.md.
2915 helper_libtestdriver1_adjust_config "crypto_full"
2916 scripts/config.py unset MBEDTLS_PK_C
2917 scripts/config.py unset MBEDTLS_PK_PARSE_C
2918 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002919
2920 # Disable modules that are accelerated - some will be re-enabled
2921 scripts/config.py unset MBEDTLS_ECDSA_C
2922 scripts/config.py unset MBEDTLS_ECDH_C
2923 scripts/config.py unset MBEDTLS_ECJPAKE_C
2924 scripts/config.py unset MBEDTLS_ECP_C
2925
2926 # Disable all curves - those that aren't accelerated should be re-enabled
2927 helper_disable_builtin_curves
2928
2929 # Restartable feature is not yet supported by PSA. Once it will in
2930 # the future, the following line could be removed (see issues
2931 # 6061, 6332 and following ones)
2932 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2933
2934 # this is not supported by the driver API yet
2935 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2936
2937 # Build
2938 # -----
2939
2940 # These hashes are needed for some ECDSA signature tests.
2941 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2942 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2943 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2944
Valerio Settiac7a8092023-10-31 12:23:44 +01002945 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002946
2947 # We expect ECDH to be re-enabled for the missing curves
2948 grep mbedtls_ecdh_ library/ecdh.o
2949 # We expect ECP to be re-enabled, however the parts specific to the
2950 # families of curves that are accelerated should be ommited.
2951 # - functions with mxz in the name are specific to Montgomery curves
2952 # - ecp_muladd is specific to Weierstrass curves
2953 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002954 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002955 not grep mbedtls_ecp_muladd library/ecp.o
2956 grep mxz library/ecp.o
2957 else
2958 grep mbedtls_ecp_muladd library/ecp.o
2959 not grep mxz library/ecp.o
2960 fi
2961 # We expect ECDSA and ECJPAKE to be re-enabled only when
2962 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002963 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002964 not grep mbedtls_ecdsa library/ecdsa.o
2965 not grep mbedtls_ecjpake library/ecjpake.o
2966 else
2967 grep mbedtls_ecdsa library/ecdsa.o
2968 grep mbedtls_ecjpake library/ecjpake.o
2969 fi
2970
2971 # Run the tests
2972 # -------------
2973
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002974 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2975 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002976}
2977
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002978component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002979 common_test_psa_crypto_config_accel_ecc_some_curves 1
2980}
2981
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002982component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002983 common_test_psa_crypto_config_accel_ecc_some_curves 0
2984}
2985
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002986# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2987# ECDH, ECDSA) with and without drivers.
2988# The input parameter is a boolean value which indicates:
2989# - 0 keep built-in EC algs,
2990# - 1 exclude built-in EC algs (driver only).
2991#
2992# This is used by the two following components to ensure they always use the
2993# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002994# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2995# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002996# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002997config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002998 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002999 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003000 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003001 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003002 # Disable modules that are accelerated
3003 scripts/config.py unset MBEDTLS_ECDSA_C
3004 scripts/config.py unset MBEDTLS_ECDH_C
3005 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003006 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003007 fi
3008
3009 # Restartable feature is not yet supported by PSA. Once it will in
3010 # the future, the following line could be removed (see issues
3011 # 6061, 6332 and following ones)
3012 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003013}
3014
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003015# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3016component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003017 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003018
3019 # Algorithms and key types to accelerate
3020 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3021 ALG_ECDH \
3022 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003023 $(helper_get_psa_key_type_list "ECC") \
3024 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003025
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003026 # Configure
3027 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003028
3029 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003030 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003031
Valerio Setti0a342c92023-09-01 09:12:31 +02003032 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003033 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3034 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003035
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003036 # Build
3037 # -----
3038
3039 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003040 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3041 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003042 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3043
Valerio Setti3fe105b2023-10-30 11:08:12 +01003044 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003045
3046 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3047 not grep mbedtls_ecdsa_ library/ecdsa.o
3048 not grep mbedtls_ecdh_ library/ecdh.o
3049 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003050 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003051
3052 # Run the tests
3053 # -------------
3054
Gilles Peskine14302ed2023-07-19 19:30:04 +02003055 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003056 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003057
Gilles Peskine14302ed2023-07-19 19:30:04 +02003058 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003059 tests/ssl-opt.sh
3060}
3061
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003062# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3063component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003064 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003065
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003066 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003067
Gilles Peskine21570cf2023-12-22 11:49:50 +01003068 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003069
Gilles Peskine14302ed2023-07-19 19:30:04 +02003070 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003071 make test
3072
Gilles Peskine14302ed2023-07-19 19:30:04 +02003073 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003074 tests/ssl-opt.sh
3075}
3076
Valerio Settie618cb02023-04-12 14:59:16 +02003077# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003078# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3079# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003080# to ensure that both tests use the same underlying configuration when testing
3081# driver's coverage with analyze_outcomes.py.
3082#
3083# This functions accepts 1 boolean parameter as follows:
3084# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3085# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3086# - 0: include built-in implementation of EC algorithms.
3087#
3088# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3089# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003090config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003091 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003092 # start with full config for maximum coverage (also enables USE_PSA)
3093 helper_libtestdriver1_adjust_config "full"
3094
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003095 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003096 # Disable modules that are accelerated
3097 scripts/config.py unset MBEDTLS_ECDSA_C
3098 scripts/config.py unset MBEDTLS_ECDH_C
3099 scripts/config.py unset MBEDTLS_ECJPAKE_C
3100 # Disable ECP module (entirely)
3101 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003102 fi
3103
Valerio Settiaecd32c2023-06-14 10:42:31 +02003104 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3105 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003106 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003107 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003108
Valerio Settie618cb02023-04-12 14:59:16 +02003109 # Restartable feature is not yet supported by PSA. Once it will in
3110 # the future, the following line could be removed (see issues
3111 # 6061, 6332 and following ones)
3112 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003113}
3114
3115# Build and test a configuration where driver accelerates all EC algs while
3116# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3117# side.
3118#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003119# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3120component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003121 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003122
3123 # Algorithms and key types to accelerate
3124 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3125 ALG_ECDH \
3126 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003127 $(helper_get_psa_key_type_list "ECC") \
3128 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003129
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003130 # Configure
3131 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003132
Valerio Settie618cb02023-04-12 14:59:16 +02003133 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003134 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003135 # Disable all the builtin curves. All the required algs are accelerated.
3136 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003137
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003138 # Build
3139 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003140
3141 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003142 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3143 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3144 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003145
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003146 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003147
Valerio Setti3fe105b2023-10-30 11:08:12 +01003148 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003149
3150 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3151 not grep mbedtls_ecdsa_ library/ecdsa.o
3152 not grep mbedtls_ecdh_ library/ecdh.o
3153 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003154 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003155 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003156
3157 # Run the tests
3158 # -------------
3159
Gilles Peskine14302ed2023-07-19 19:30:04 +02003160 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003161 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003162
Gilles Peskine14302ed2023-07-19 19:30:04 +02003163 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003164 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003165}
3166
3167# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003168# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003169# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003170component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003171 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003172
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003173 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003174
Gilles Peskine21570cf2023-12-22 11:49:50 +01003175 make
Valerio Settie618cb02023-04-12 14:59:16 +02003176
Gilles Peskine14302ed2023-07-19 19:30:04 +02003177 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003178 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003179
Gilles Peskine14302ed2023-07-19 19:30:04 +02003180 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003181 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003182}
3183
Valerio Setti4e2f2442023-08-15 10:10:26 +02003184# This is a common configuration helper used directly from:
3185# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3186# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3187# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003188# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003189# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003190# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003191# - this is the reference component of the above
3192# - it still disables RSA and FFDH, but it uses builtin EC algs
3193# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3194# - accelerate all EC and FFDH algs, disable only RSA
3195# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3196# - this is the reference component of the above
3197# - it still disables RSA, but it uses builtin EC and FFDH algs
3198#
3199# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003200# $1: a boolean value which states if we are testing an accelerated scenario
3201# or not.
3202# $2: a string value which states which components are tested. Allowed values
3203# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003204config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003205 driver_only="$1"
3206 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003207 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003208 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003209
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003210 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003211 # Disable modules that are accelerated
3212 scripts/config.py unset MBEDTLS_ECDSA_C
3213 scripts/config.py unset MBEDTLS_ECDH_C
3214 scripts/config.py unset MBEDTLS_ECJPAKE_C
3215 # Disable ECP module (entirely)
3216 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003217 # Also disable bignum
3218 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003219 fi
3220
3221 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3222 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3223 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3224 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3225
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003226 # RSA support is intentionally disabled on this test because RSA_C depends
3227 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003228 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3229 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 +02003230 scripts/config.py unset MBEDTLS_RSA_C
3231 scripts/config.py unset MBEDTLS_PKCS1_V15
3232 scripts/config.py unset MBEDTLS_PKCS1_V21
3233 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3234 # Also disable key exchanges that depend on RSA
3235 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3236 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3237 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3238 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3239 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3240
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003241 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003242 # When testing ECC only, we disable FFDH support, both from builtin and
3243 # PSA sides, and also disable the key exchanges that depend on DHM.
3244 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3245 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 +01003246 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003247 scripts/config.py unset MBEDTLS_DHM_C
3248 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3249 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3250 else
3251 # When testing ECC and DH instead, we disable DHM and depending key
3252 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003253 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003254 scripts/config.py unset MBEDTLS_DHM_C
3255 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3256 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3257 fi
3258 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003259
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003260 # Restartable feature is not yet supported by PSA. Once it will in
3261 # the future, the following line could be removed (see issues
3262 # 6061, 6332 and following ones)
3263 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3264}
3265
Valerio Setti4e2f2442023-08-15 10:10:26 +02003266# Common helper used by:
3267# - component_test_psa_crypto_config_accel_ecc_no_bignum
3268# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003269#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003270# The goal is to build and test accelerating either:
3271# - ECC only or
3272# - both ECC and FFDH
3273#
3274# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003275# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3276# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003277common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003278 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003279
Valerio Setti5dfaca42023-09-05 08:48:51 +02003280 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003281 if [ "$test_target" = "ECC_DH" ]; then
3282 accel_text="ECC/FFDH"
3283 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003284 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003285 accel_text="ECC"
3286 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003287 fi
3288
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003289 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003290
3291 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003292 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3293 ALG_ECDH \
3294 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003295 $(helper_get_psa_key_type_list "ECC") \
3296 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003297 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003298 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003299 loc_accel_list="$loc_accel_list \
3300 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003301 $(helper_get_psa_key_type_list "DH") \
3302 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003303 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003304
3305 # Configure
3306 # ---------
3307
3308 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003309 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003310 # Disable all the builtin curves. All the required algs are accelerated.
3311 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003312
3313 # Build
3314 # -----
3315
3316 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003317 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3318 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3319 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003320
3321 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3322
Valerio Setti3fe105b2023-10-30 11:08:12 +01003323 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003324
3325 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3326 not grep mbedtls_ecdsa_ library/ecdsa.o
3327 not grep mbedtls_ecdh_ library/ecdh.o
3328 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003329 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003330 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003331 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003332 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003333 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003334
3335 # Run the tests
3336 # -------------
3337
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003338 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003339
Gilles Peskine21570cf2023-12-22 11:49:50 +01003340 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003341
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003342 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003343 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003344}
3345
Valerio Setti4e2f2442023-08-15 10:10:26 +02003346# Common helper used by:
3347# - component_test_psa_crypto_config_reference_ecc_no_bignum
3348# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3349#
3350# The goal is to build and test a reference scenario (i.e. with builtin
3351# components) compared to the ones used in
3352# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3353#
3354# It is meant to be used in conjunction with
3355# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3356# coverage analysis in "analyze_outcomes.py" script.
3357common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003358 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003359
Valerio Setti5dfaca42023-09-05 08:48:51 +02003360 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003361 if [ "$test_target" = "ECC_DH" ]; then
3362 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003363 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003364 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003365 fi
3366
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003367 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003368
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003369 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003370
Gilles Peskine21570cf2023-12-22 11:49:50 +01003371 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003372
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003373 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003374 make test
3375
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003376 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003377 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003378}
3379
Valerio Setti4e2f2442023-08-15 10:10:26 +02003380component_test_psa_crypto_config_accel_ecc_no_bignum () {
3381 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3382}
3383
3384component_test_psa_crypto_config_reference_ecc_no_bignum () {
3385 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3386}
3387
3388component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3389 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3390}
3391
3392component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3393 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3394}
3395
Valerio Settiac6d35f2023-08-04 12:49:11 +02003396# Helper for setting common configurations between:
3397# - component_test_tfm_config_p256m_driver_accel_ec()
3398# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003399common_tfm_config () {
3400 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003401 cp configs/config-tfm.h "$CONFIG_H"
3402 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3403 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003404
Yanray Wang73bb2312023-09-25 11:21:15 +08003405 # Other config adjustment to make the tests pass.
3406 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003407 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003408 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3409 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003410
Yanray Wang73bb2312023-09-25 11:21:15 +08003411 # Config adjustment for better test coverage in our environment.
3412 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003413 #
3414 # Enable filesystem I/O for the benefit of PK parse/write tests.
3415 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3416}
3417
Valerio Settiac6d35f2023-08-04 12:49:11 +02003418# Keep this in sync with component_test_tfm_config() as they are both meant
3419# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003420component_test_tfm_config_p256m_driver_accel_ec () {
3421 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3422
3423 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003424
Dave Rodgman897bb772023-11-15 16:34:20 +00003425 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003426 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003427
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003428 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3429 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003430 not grep mbedtls_ecdh_ library/ecdh.o
3431 not grep mbedtls_ecjpake_ library/ecjpake.o
3432 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3433 not grep mbedtls_ecp_ library/ecp.o
3434 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003435 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003436 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003437 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003438 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003439
Valerio Setti5e18b902023-12-04 12:07:30 +01003440 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3441 # files, so we want to ensure that it has not be re-enabled accidentally.
3442 not grep mbedtls_cipher library/cipher.o
3443
Valerio Settib7e95442023-03-21 11:52:33 +01003444 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003445 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003446 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003447}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003448
Valerio Settiac6d35f2023-08-04 12:49:11 +02003449# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3450# they are both meant to be used in analyze_outcomes.py for driver's coverage
3451# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003452component_test_tfm_config() {
3453 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003454
Dave Rodgman897bb772023-11-15 16:34:20 +00003455 # Disable P256M driver, which is on by default, so that analyze_outcomes
3456 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3457 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3458
Valerio Setti52ba0e32023-08-04 12:43:03 +02003459 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003460 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003461
Dave Rodgman897bb772023-11-15 16:34:20 +00003462 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003463 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003464
Valerio Setti5e18b902023-12-04 12:07:30 +01003465 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3466 # files, so we want to ensure that it has not be re-enabled accidentally.
3467 not grep mbedtls_cipher library/cipher.o
3468
Valerio Setti52ba0e32023-08-04 12:43:03 +02003469 msg "test: TF-M config"
3470 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003471}
3472
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003473# Common helper for component_full_without_ecdhe_ecdsa() and
3474# component_full_without_ecdhe_ecdsa_and_tls13() which:
3475# - starts from the "full" configuration minus the list of symbols passed in
3476# as 1st parameter
3477# - build
3478# - test only TLS (i.e. test_suite_tls and ssl-opt)
3479build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003480 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003481
3482 msg "build: full minus something, test TLS"
3483
3484 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003485 for sym in $symbols_to_disable; do
3486 echo "Disabling $sym"
3487 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003488 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003489
Gilles Peskine21570cf2023-12-22 11:49:50 +01003490 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003491
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003492 msg "test: full minus something, test TLS"
3493 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003494
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003495 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003496 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003497}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003498
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003499component_full_without_ecdhe_ecdsa () {
3500 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003501}
3502
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003503component_full_without_ecdhe_ecdsa_and_tls13 () {
3504 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3505 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003506}
3507
Valerio Setti249b18a2023-06-20 12:08:30 +02003508# This is an helper used by:
3509# - component_test_psa_ecc_key_pair_no_derive
3510# - component_test_psa_ecc_key_pair_no_generate
3511# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3512# enabled, but one. Input arguments are as follows:
3513# - $1 is the key type under test, i.e. ECC/RSA/DH
3514# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003515build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003516 key_type=$1
3517 unset_option=$2
3518 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003519
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003520 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003521 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003522 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3523 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3524
3525 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3526 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003527 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003528
Gilles Peskine21570cf2023-12-22 11:49:50 +01003529 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003530
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003531 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003532 make test
3533}
3534
3535component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003536 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003537}
3538
3539component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003540 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003541}
3542
Pengyu Lve705f572023-12-06 16:38:15 +08003543config_psa_crypto_accel_rsa () {
3544 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003545
Pengyu Lve705f572023-12-06 16:38:15 +08003546 # Start from crypto_full config (no X.509, no TLS)
3547 helper_libtestdriver1_adjust_config "crypto_full"
3548
3549 if [ "$driver_only" -eq 1 ]; then
3550 # Remove RSA support and its dependencies
3551 scripts/config.py unset MBEDTLS_RSA_C
3552 scripts/config.py unset MBEDTLS_PKCS1_V15
3553 scripts/config.py unset MBEDTLS_PKCS1_V21
3554
3555 # We need PEM parsing in the test library as well to support the import
3556 # of PEM encoded RSA keys.
3557 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3558 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3559 fi
3560}
3561
3562component_test_psa_crypto_config_accel_rsa_crypto () {
3563 msg "build: crypto_full with accelerated RSA"
3564
3565 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3566 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3567 KEY_TYPE_RSA_PUBLIC_KEY \
3568 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3569 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3570 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3571 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003572
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003573 # Configure
3574 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003575
Pengyu Lve705f572023-12-06 16:38:15 +08003576 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003577
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003578 # Build
3579 # -----
3580
Pengyu Lve705f572023-12-06 16:38:15 +08003581 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003582 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 +08003583 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003584 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003585
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003586 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003587
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003588 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003589 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003590
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003591 # Run the tests
3592 # -------------
3593
Pengyu Lve705f572023-12-06 16:38:15 +08003594 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003595 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003596}
3597
3598component_test_psa_crypto_config_reference_rsa_crypto () {
3599 msg "build: crypto_full with non-accelerated RSA"
3600
3601 # Configure
3602 # ---------
3603 config_psa_crypto_accel_rsa 0
3604
3605 # Build
3606 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003607 make
Pengyu Lve705f572023-12-06 16:38:15 +08003608
3609 # Run the tests
3610 # -------------
3611 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003612 make test
3613}
3614
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003615# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003616# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003617component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003618 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003619
Valerio Setti4590bc22023-06-13 15:39:23 +02003620 # Create a temporary output file unless there is already one set
3621 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3622 REMOVE_OUTCOME_ON_EXIT="no"
3623 else
3624 REMOVE_OUTCOME_ON_EXIT="yes"
3625 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3626 export MBEDTLS_TEST_OUTCOME_FILE
3627 fi
3628
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003629 # Start from crypto configuration
3630 scripts/config.py crypto
3631
3632 # Remove RSA support and its dependencies
3633 scripts/config.py unset MBEDTLS_PKCS1_V15
3634 scripts/config.py unset MBEDTLS_PKCS1_V21
3635 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3636 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3637 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3638 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3639 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3640 scripts/config.py unset MBEDTLS_RSA_C
3641 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3642
3643 # Enable PSA support
3644 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3645
Valerio Setti01cc88a2023-06-15 11:53:08 +02003646 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003647 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003648 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3649 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3650 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003651
3652 make
3653
Valerio Setti01cc88a2023-06-15 11:53:08 +02003654 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003655 make test
3656
3657 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3658 # performing RSA signature.
3659 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3660 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3661
3662 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3663 rm $MBEDTLS_TEST_OUTCOME_FILE
3664 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003665}
3666
Ronald Cronb2312452021-05-08 14:32:59 +02003667component_test_psa_crypto_config_accel_hash () {
3668 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3669
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003670 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3671 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3672 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003673
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003674 # Configure
3675 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003676
Ronald Cron46ac0652024-03-18 12:39:04 +01003677 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003678 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003679
3680 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003681 scripts/config.py unset MBEDTLS_MD5_C
3682 scripts/config.py unset MBEDTLS_RIPEMD160_C
3683 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003684 scripts/config.py unset MBEDTLS_SHA224_C
3685 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003686 scripts/config.py unset MBEDTLS_SHA384_C
3687 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003688 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003689
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003690 # Build
3691 # -----
3692
3693 helper_libtestdriver1_make_drivers "$loc_accel_list"
3694
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003695 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003696
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003697 # There's a risk of something getting re-enabled via config_psa.h;
3698 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3699 not grep mbedtls_md5 library/md5.o
3700 not grep mbedtls_sha1 library/sha1.o
3701 not grep mbedtls_sha256 library/sha256.o
3702 not grep mbedtls_sha512 library/sha512.o
3703 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003704
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003705 # Run the tests
3706 # -------------
3707
Ronald Cronb2312452021-05-08 14:32:59 +02003708 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3709 make test
3710}
3711
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003712component_test_psa_crypto_config_accel_hash_keep_builtins () {
3713 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3714 # This component ensures that all the test cases for
3715 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3716
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003717 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3718 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3719 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003720
Ronald Cron46ac0652024-03-18 12:39:04 +01003721 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003722 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003723
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003724 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003725
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003726 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003727
3728 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3729 make test
3730}
3731
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003732# Auxiliary function to build config for hashes with and without drivers
3733config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003734 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003735 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003736 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003737 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003738 # disable the built-in implementation of hashes
3739 scripts/config.py unset MBEDTLS_MD5_C
3740 scripts/config.py unset MBEDTLS_RIPEMD160_C
3741 scripts/config.py unset MBEDTLS_SHA1_C
3742 scripts/config.py unset MBEDTLS_SHA224_C
3743 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003744 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003745 scripts/config.py unset MBEDTLS_SHA384_C
3746 scripts/config.py unset MBEDTLS_SHA512_C
3747 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003748 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003749 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003750}
3751
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003752# Note that component_test_psa_crypto_config_reference_hash_use_psa
3753# is related to this component and both components need to be kept in sync.
3754# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003755component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003756 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003757
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003758 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3759 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3760 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003761
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003762 # Configure
3763 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003764
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003765 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003766
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003767 # Build
3768 # -----
3769
3770 helper_libtestdriver1_make_drivers "$loc_accel_list"
3771
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003772 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003773
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003774 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003775 # 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 +02003776 not grep mbedtls_md5 library/md5.o
3777 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003778 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003779 not grep mbedtls_sha512 library/sha512.o
3780 not grep mbedtls_ripemd160 library/ripemd160.o
3781
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003782 # Run the tests
3783 # -------------
3784
Gilles Peskine14302ed2023-07-19 19:30:04 +02003785 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003786 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003787
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003788 # This is mostly useful so that we can later compare outcome files with
3789 # the reference config in analyze_outcomes.py, to check that the
3790 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003791 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003792 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003793
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003794 # This is to make sure all ciphersuites are exercised, but we don't need
3795 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003796 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003797 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003798}
3799
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003800# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3801# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3802# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3803# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003804component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003805 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003806
3807 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003808
Gilles Peskine21570cf2023-12-22 11:49:50 +01003809 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003810
Gilles Peskine14302ed2023-07-19 19:30:04 +02003811 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003812 make test
3813
Gilles Peskine14302ed2023-07-19 19:30:04 +02003814 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003815 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003816}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003817
Valerio Setti8eb310c2024-01-22 16:22:57 +01003818# Auxiliary function to build config for hashes with and without drivers
3819config_psa_crypto_hmac_use_psa () {
3820 driver_only="$1"
3821 # start with config full for maximum coverage (also enables USE_PSA)
3822 helper_libtestdriver1_adjust_config "full"
3823
Valerio Setticd89b0b2024-01-24 14:24:55 +01003824 if [ "$driver_only" -eq 1 ]; then
3825 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3826 # is still enabled though (for ENTROPY_C among others).
3827 scripts/config.py unset MBEDTLS_MD_C
3828 # Disable also the builtin hashes since they are supported by the driver
3829 # and MD module is able to perform PSA dispathing.
3830 scripts/config.py unset-all MBEDTLS_SHA
3831 scripts/config.py unset MBEDTLS_MD5_C
3832 scripts/config.py unset MBEDTLS_RIPEMD160_C
3833 fi
3834
Valerio Setti8eb310c2024-01-22 16:22:57 +01003835 # Direct dependencies of MD_C. We disable them also in the reference
3836 # component to work with the same set of features.
3837 scripts/config.py unset MBEDTLS_PKCS7_C
3838 scripts/config.py unset MBEDTLS_PKCS5_C
3839 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3840 scripts/config.py unset MBEDTLS_HKDF_C
3841 # Dependencies of HMAC_DRBG
3842 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3843 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3844}
3845
3846component_test_psa_crypto_config_accel_hmac() {
3847 msg "test: full with accelerated hmac"
3848
3849 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3850 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3851 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3852 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3853
3854 # Configure
3855 # ---------
3856
3857 config_psa_crypto_hmac_use_psa 1
3858
Valerio Setti8eb310c2024-01-22 16:22:57 +01003859 # Build
3860 # -----
3861
3862 helper_libtestdriver1_make_drivers "$loc_accel_list"
3863
3864 helper_libtestdriver1_make_main "$loc_accel_list"
3865
3866 # Ensure that built-in support for HMAC is disabled.
3867 not grep mbedtls_md_hmac library/md.o
3868
3869 # Run the tests
3870 # -------------
3871
3872 msg "test: full with accelerated hmac"
3873 make test
3874}
3875
3876component_test_psa_crypto_config_reference_hmac() {
3877 msg "test: full without accelerated hmac"
3878
3879 config_psa_crypto_hmac_use_psa 0
3880
3881 make
3882
3883 msg "test: full without accelerated hmac"
3884 make test
3885}
3886
Valerio Setti9da01a72023-12-18 17:38:18 +01003887component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003888 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003889
Valerio Setti9da01a72023-12-18 17:38:18 +01003890 # Albeit this components aims at accelerating DES which should only support
3891 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3892 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003893 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3894 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3895 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003896
Valerio Setti9da01a72023-12-18 17:38:18 +01003897 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3898 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3899 # of this component. This limitation will be addressed by #8598.
3900
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003901 # Configure
3902 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003903
Valerio Setti9a427302023-10-17 11:40:42 +02003904 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003905 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003906
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003907 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003908 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3909 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3910 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3911 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3912 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3913 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3914 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003915 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003916
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003917 # Build
3918 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003919
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003920 helper_libtestdriver1_make_drivers "$loc_accel_list"
3921
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003922 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003923
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003924 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003925 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003926
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003927 # Run the tests
3928 # -------------
3929
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003930 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003931 make test
3932}
3933
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003934component_test_psa_crypto_config_accel_aead () {
3935 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3936
Valerio Setti3f02bb72023-10-02 15:57:33 +02003937 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3938 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003939
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003940 # Configure
3941 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003942
Valerio Setti3f02bb72023-10-02 15:57:33 +02003943 # Start from full config
3944 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003945
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003946 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003947 scripts/config.py unset MBEDTLS_GCM_C
3948 scripts/config.py unset MBEDTLS_CCM_C
3949 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003950
Valerio Settia50b89e2023-11-08 15:58:47 +01003951 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3952 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003953
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003954 # Build
3955 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003956
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003957 helper_libtestdriver1_make_drivers "$loc_accel_list"
3958
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003959 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003960
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003961 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003962 not grep mbedtls_ccm library/ccm.o
3963 not grep mbedtls_gcm library/gcm.o
3964 not grep mbedtls_chachapoly library/chachapoly.o
3965
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003966 # Run the tests
3967 # -------------
3968
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003969 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3970 make test
3971}
3972
Valerio Settib680fc42023-10-13 09:29:37 +02003973# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003974# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3975# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3976common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003977 # Start from the full config
3978 helper_libtestdriver1_adjust_config "full"
3979
Valerio Settib680fc42023-10-13 09:29:37 +02003980 scripts/config.py unset MBEDTLS_NIST_KW_C
3981}
3982
Valerio Settib6b301f2023-10-04 12:05:05 +02003983# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003984# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3985# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003986# are meant to be used together in analyze_outcomes.py script in order to test
3987# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003988component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3989 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003990
Valerio Settiad8b7f02023-10-25 12:39:50 +02003991 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 +01003992 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003993 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003994 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3995
3996 # Configure
3997 # ---------
3998
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003999 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004000
4001 # Disable the things that are being accelerated
4002 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4003 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4004 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4005 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4006 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4007 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4008 scripts/config.py unset MBEDTLS_GCM_C
4009 scripts/config.py unset MBEDTLS_CCM_C
4010 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004011 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004012 scripts/config.py unset MBEDTLS_DES_C
4013 scripts/config.py unset MBEDTLS_AES_C
4014 scripts/config.py unset MBEDTLS_ARIA_C
4015 scripts/config.py unset MBEDTLS_CHACHA20_C
4016 scripts/config.py unset MBEDTLS_CAMELLIA_C
4017
Valerio Settiec9b2582023-11-08 16:50:54 +01004018 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4019 # does not depend on it.
4020 scripts/config.py unset MBEDTLS_CIPHER_C
4021
Valerio Settib6b301f2023-10-04 12:05:05 +02004022 # Build
4023 # -----
4024
4025 helper_libtestdriver1_make_drivers "$loc_accel_list"
4026
4027 helper_libtestdriver1_make_main "$loc_accel_list"
4028
4029 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004030 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004031 not grep mbedtls_des library/des.o
4032 not grep mbedtls_aes library/aes.o
4033 not grep mbedtls_aria library/aria.o
4034 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004035 not grep mbedtls_ccm library/ccm.o
4036 not grep mbedtls_gcm library/gcm.o
4037 not grep mbedtls_chachapoly library/chachapoly.o
4038 not grep mbedtls_cmac library/cmac.o
4039
4040 # Run the tests
4041 # -------------
4042
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004043 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004044 make test
Valerio Settif9414552023-11-09 10:43:20 +01004045
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004046 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004047 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004048
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004049 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004050 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004051}
4052
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004053component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4054 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4055 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004056
Gilles Peskine21570cf2023-12-22 11:49:50 +01004057 make
Valerio Settif9414552023-11-09 10:43:20 +01004058
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004059 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004060 make test
Valerio Settif9414552023-11-09 10:43:20 +01004061
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004062 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004063 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004064
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004065 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004066 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004067}
4068
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004069common_block_cipher_dispatch() {
4070 TEST_WITH_DRIVER="$1"
4071
4072 # Start from the full config
4073 helper_libtestdriver1_adjust_config "full"
4074
4075 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4076 # Disable key types that are accelerated (there is no legacy equivalent
4077 # symbol for ECB)
4078 scripts/config.py unset MBEDTLS_AES_C
4079 scripts/config.py unset MBEDTLS_ARIA_C
4080 scripts/config.py unset MBEDTLS_CAMELLIA_C
4081 fi
4082
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004083 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004084 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004085 # Keep this also in the reference component in order to skip the same tests
4086 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004087 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4088 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4089 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4090 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4091 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4092 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4093 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Cron7d949ae2024-05-15 18:31:17 +02004094 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004095
4096 # Disable direct dependency on AES_C
4097 scripts/config.py unset MBEDTLS_NIST_KW_C
4098
4099 # Prevent the cipher module from using deprecated PSA path. The reason is
4100 # that otherwise there will be tests relying on "aes_info" (defined in
4101 # "cipher_wrap.c") whose functions are not available when AES_C is
4102 # not defined. ARIA and Camellia are not a problem in this case because
4103 # the PSA path is not tested for these key types.
4104 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4105}
4106
Valerio Settif8e6cba2023-12-12 11:53:39 +01004107component_test_full_block_cipher_psa_dispatch () {
4108 msg "build: full + PSA dispatch in block_cipher"
4109
4110 loc_accel_list="ALG_ECB_NO_PADDING \
4111 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4112
4113 # Configure
4114 # ---------
4115
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004116 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004117
Valerio Settif8e6cba2023-12-12 11:53:39 +01004118 # Build
4119 # -----
4120
4121 helper_libtestdriver1_make_drivers "$loc_accel_list"
4122
4123 helper_libtestdriver1_make_main "$loc_accel_list"
4124
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004125 # Make sure disabled components were not re-enabled by accident (additive
4126 # config)
4127 not grep mbedtls_aes_ library/aes.o
4128 not grep mbedtls_aria_ library/aria.o
4129 not grep mbedtls_camellia_ library/camellia.o
4130
Valerio Settif8e6cba2023-12-12 11:53:39 +01004131 # Run the tests
4132 # -------------
4133
4134 msg "test: full + PSA dispatch in block_cipher"
4135 make test
4136}
4137
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004138# This is the reference component of component_test_full_block_cipher_psa_dispatch
4139component_test_full_block_cipher_legacy_dispatch () {
4140 msg "build: full + legacy dispatch in block_cipher"
4141
4142 common_block_cipher_dispatch 0
4143
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004144 make
4145
4146 msg "test: full + legacy dispatch in block_cipher"
4147 make test
4148}
4149
Gilles Peskine36dea152023-07-20 22:19:45 +02004150component_test_aead_chachapoly_disabled() {
4151 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004152 scripts/config.py full
4153 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004154 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004155 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004156
Gilles Peskine36dea152023-07-20 22:19:45 +02004157 msg "test: full minus CHACHAPOLY"
4158 make test
4159}
4160
4161component_test_aead_only_ccm() {
4162 msg "build: full minus CHACHAPOLY and GCM"
4163 scripts/config.py full
4164 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4165 scripts/config.py unset MBEDTLS_GCM_C
4166 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4167 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004168 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004169
4170 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004171 make test
4172}
4173
Ronald Crone501d0e2023-07-10 08:31:19 +02004174component_test_ccm_aes_sha256() {
4175 msg "build: CCM + AES + SHA256 configuration"
4176
Ronald Cron7612d8c2023-07-20 10:03:54 +02004177 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004178 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004179
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004180 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004181
4182 msg "test: CCM + AES + SHA256 configuration"
4183 make test
4184}
4185
John Durkopd0321952020-10-29 21:37:36 -07004186# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004187component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004188 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004189 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004190 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004191 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004192 scripts/config.py unset MBEDTLS_ECDH_C
4193 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4194 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4195 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4196 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4197 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4198 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004199 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004200}
4201
4202# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004203component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004204 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004205 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004206 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004207 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004208 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004209 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004210}
4211
4212# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004213component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004214 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004215 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004216 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
4217 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004218 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4219 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004220 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004221 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004222}
4223
John Durkop1b7ee052020-11-27 08:51:22 -08004224# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4225component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004226 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004227 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004228 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004229 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004230 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4231 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4232 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4233 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4234 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4235 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4236 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004237 scripts/config.py unset MBEDTLS_LMS_C
4238 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004239 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004240 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004241}
4242
4243# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4244component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004245 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004246 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004247 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004248 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004249 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4250 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4251 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4252 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4253 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4254 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4255 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004256 scripts/config.py unset MBEDTLS_LMS_C
4257 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004258 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004259 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004260}
4261
4262# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4263component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004264 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004265 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004266 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004267 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004268 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4269 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4270 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4271 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4272 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4273 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4274 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004275 scripts/config.py unset MBEDTLS_LMS_C
4276 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004277 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004278 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004279}
4280
4281# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4282component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004283 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004284 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004285 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004286 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004287 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4288 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4289 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4290 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4291 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4292 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004293 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004294 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004295}
4296
4297# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4298component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004299 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004300 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004301 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004302 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004303 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4304 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4305 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4306 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4307 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4308 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004309 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004310 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004311}
4312
4313# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4314component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004315 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004316 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004317 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004318 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004319 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4320 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4321 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4322 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4323 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4324 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004325 scripts/config.py unset MBEDTLS_LMS_C
4326 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004327 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004328 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004329}
4330
4331# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4332component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004333 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004334 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004335 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004336 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004337 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4338 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4339 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4340 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4341 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4342 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4343 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004344 scripts/config.py unset MBEDTLS_LMS_C
4345 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004346 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004347 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004348}
4349
John Durkopd0321952020-10-29 21:37:36 -07004350# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004351component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004352 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_CRYPT + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopd0321952020-10-29 21:37:36 -07004353 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004354 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004355 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004356 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4357 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4358 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4359 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004360 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004361 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004362}
4363
4364# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004365component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004366 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_SIGN + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004367 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004368 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004369 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004370 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4371 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4372 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4373 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004374 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004375 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004376}
4377
4378# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004379component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004380 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_OAEP + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004381 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004382 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004383 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004384 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4385 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4386 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4387 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004388 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004389 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004390}
4391
4392# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004393component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004394 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PSS + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004395 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004396 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004397 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004398 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4399 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4400 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4401 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004402 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004403 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004404}
4405
4406# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004407component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004408 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_xxx + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004409 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004410 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004411 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004412 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4413 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4414 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4415 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4416 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004417 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004418 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004419}
4420
4421# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004422component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004423 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004424 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004425 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004426 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004427 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4428 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004429 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004430 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004431}
4432
Dave Rodgmanc164c072023-06-28 09:43:23 +01004433
Dave Rodgman904c5892023-06-28 17:36:02 +01004434support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004435 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004436}
4437
Dave Rodgman904c5892023-06-28 17:36:02 +01004438component_build_tfm_armcc() {
4439 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004440 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004441
Dave Rodgman88651c42023-06-29 12:35:51 +01004442 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004443 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 +01004444}
4445
4446component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004447 # Check that the TF-M configuration can build cleanly with various
4448 # warning flags enabled. We don't build or run tests, since the
4449 # TF-M configuration needs a TF-M platform. A tweaked version of
4450 # the configuration that works on mainstream platforms is in
4451 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004452 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004453
Dave Rodgman88651c42023-06-29 12:35:51 +01004454 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004455 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 +01004456
Dave Rodgman904c5892023-06-28 17:36:02 +01004457 msg "build: TF-M config, gcc native build"
4458 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004459 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 +01004460}
4461
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004462# Test that the given .o file builds with all (valid) combinations of the given options.
4463#
4464# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4465#
4466# The validator function is the name of a function to validate the combination of options.
4467# It may be "" if all combinations are valid.
4468# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004469# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004470build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004471 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004472 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004473 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004474 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004475 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004476
Dave Rodgman42436102023-10-03 15:47:05 +01004477 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004478 for opt in "${options[@]}"; do
4479 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004480 done
4481
4482 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004483 cd $(dirname ${file})
4484 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004485
Dave Rodgman920343a2023-10-01 18:41:09 +01004486 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004487 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 +01004488
Dave Rodgman42436102023-10-03 15:47:05 +01004489 # Extract the command generated by the Makefile to build the target file.
4490 # This ensures that we have any include paths, macro definitions, etc
4491 # that may be applied by make.
4492 # 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 +01004493 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004494
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004495 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004496 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004497
Dave Rodgman28e38d82023-10-04 11:50:30 +01004498 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004499 source_file=${file%.o}.c
4500
4501 targets=0
4502 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004503
Dave Rodgman28e38d82023-10-04 11:50:30 +01004504 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004505 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004506 # each bit of $i is used to determine if options[i] will be set or not
4507 target="t"
4508 clang_args=""
4509 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004510 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004511 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004512 clang_args="${clang_args} ${opt}"
4513 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004514 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004515 done
4516
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004517 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004518 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004519 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004520 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004521
Dave Rodgman28e38d82023-10-04 11:50:30 +01004522 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004523 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004524 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004525 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004526
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004527 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004528
Dave Rodgman920343a2023-10-01 18:41:09 +01004529 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004530 make -s -f ${makefile} build_test_config_combos
4531 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004532
4533 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004534 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004535}
4536
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004537validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004538 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4539 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004540 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004541 fi
4542 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4543 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004544 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004545 fi
4546 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004547 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004548}
4549
4550component_build_aes_variations() {
4551 # 18s - around 90ms per clang invocation on M1 Pro
4552 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004553 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004554 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004555
Yanray Wangbc29aef2023-11-06 11:08:17 +08004556 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004557 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004558
Dave Rodgman42436102023-10-03 15:47:05 +01004559 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004560 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4561 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4562 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4563 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004564
4565 cd "$MBEDTLS_ROOT_DIR"
4566 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4567
Yanray Wang42be1ba2023-11-23 14:28:47 +08004568 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004569 # manually set or unset those configurations to check
4570 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004571 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4572 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4573 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4574 scripts/config.py unset MBEDTLS_DES_C
4575 scripts/config.py unset MBEDTLS_NIST_KW_C
4576 build_test_config_combos library/aes.o validate_aes_config_variations \
4577 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4578 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4579 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4580 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004581}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004582
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004583component_test_no_platform () {
4584 # Full configuration build, without platform support, file IO and net sockets.
4585 # This should catch missing mbedtls_printf definitions, and by disabling file
4586 # IO, it should catch missing '#include <stdio.h>'
4587 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004588 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004589 scripts/config.py unset MBEDTLS_PLATFORM_C
4590 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004591 scripts/config.py unset MBEDTLS_FS_IO
4592 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004593 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004594 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004595 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004596 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004597 # to re-enable platform integration features otherwise disabled in C99 builds
4598 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004599 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004600}
Gilles Peskine7c652162017-12-11 00:01:40 +01004601
4602component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004603 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004604 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4605 scripts/config.py full
4606 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004607 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4608 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4609 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4610 make
4611}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004612
Gilles Peskine8f073122018-11-27 15:58:47 +01004613component_build_no_ssl_srv () {
4614 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004615 scripts/config.py full
4616 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004617 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004618}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004619
Gilles Peskine8f073122018-11-27 15:58:47 +01004620component_build_no_ssl_cli () {
4621 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004622 scripts/config.py full
4623 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004624 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004625}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004626
Gilles Peskine8f073122018-11-27 15:58:47 +01004627component_build_no_sockets () {
4628 # Note, C99 compliance can also be tested with the sockets support disabled,
4629 # as that requires a POSIX platform (which isn't the same as C99).
4630 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004631 scripts/config.py full
4632 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4633 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4634 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4635}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004636
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004637component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004638 msg "build: default config with memory buffer allocator and backtrace enabled"
4639 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4640 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4641 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004642 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004643 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004644 make
4645
4646 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4647 make test
4648}
4649
4650component_test_memory_buffer_allocator () {
4651 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004652 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4653 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004654 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004655 make
4656
4657 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4658 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004659
4660 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4661 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004662 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004663}
4664
Gilles Peskine8f073122018-11-27 15:58:47 +01004665component_test_no_max_fragment_length () {
4666 # Run max fragment length tests with MFL disabled
4667 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004668 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004669 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004670 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004671
Gilles Peskine8f073122018-11-27 15:58:47 +01004672 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004673 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004674}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004675
Hanno Becker545ced42019-02-19 11:10:48 +00004676component_test_asan_remove_peer_certificate () {
4677 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004678 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004679 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004680 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004681 make
4682
4683 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4684 make test
4685
4686 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004687 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004688
4689 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004690 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004691
4692 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004693 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004694}
4695
Gilles Peskine8f073122018-11-27 15:58:47 +01004696component_test_no_max_fragment_length_small_ssl_out_content_len () {
4697 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004698 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4699 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4700 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004701 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004702 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004703
Gilles Peskine8f073122018-11-27 15:58:47 +01004704 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004705 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004706
4707 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004708 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004709}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004710
Darryl Greenaad82f92019-12-02 10:53:11 +00004711component_test_variable_ssl_in_out_buffer_len () {
4712 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4713 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004714 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004715 make
4716
4717 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4718 make test
4719
4720 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004721 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004722
4723 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004724 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004725}
4726
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004727component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004728 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004729 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004730
Dave Rodgman17127e92023-12-14 16:42:48 +00004731 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004732 make
4733
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004734 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004735 make test
4736
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004737 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004738 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004739
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004740 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004741 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004742}
4743
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004744component_test_ssl_alloc_buffer_and_mfl () {
4745 msg "build: default config with memory buffer allocator and MFL extension"
4746 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4747 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4748 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4749 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4750 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004751 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004752 make
4753
4754 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4755 make test
4756
4757 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 +02004758 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004759}
4760
Gilles Peskine636c26a2020-03-04 20:46:15 +01004761component_test_when_no_ciphersuites_have_mac () {
4762 msg "build: when no ciphersuites have MAC"
4763 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004764 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004765 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004766 make
4767
4768 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4769 make test
4770
4771 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004772 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004773}
4774
Raoul Strackxa4e86142020-06-15 17:03:13 +02004775component_test_no_date_time () {
4776 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4777 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004778 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004779 make
4780
4781 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4782 make test
4783}
4784
Gilles Peskine8f073122018-11-27 15:58:47 +01004785component_test_platform_calloc_macro () {
4786 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004787 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4788 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4789 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004790 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004791 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004792
Gilles Peskine8f073122018-11-27 15:58:47 +01004793 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4794 make test
4795}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004796
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004797component_test_malloc_0_null () {
4798 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004799 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004800 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 +02004801
4802 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4803 make test
4804
4805 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4806 # Just the calloc selftest. "make test" ran the others as part of the
4807 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004808 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004809
4810 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4811 # Run a subset of the tests. The choice is a balance between coverage
4812 # and time (including time indirectly wasted due to flaky tests).
4813 # The current choice is to skip tests whose description includes
4814 # "proxy", which is an approximation of skipping tests that use the
4815 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004816 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004817}
4818
Dave Rodgman6a08b682023-06-19 11:51:33 +01004819support_test_aesni() {
4820 # Check that gcc targets x86_64 (we can build AESNI), and check for
4821 # AESNI support on the host (we can run AESNI).
4822 #
4823 # The name of this function is possibly slightly misleading, but needs to align
4824 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004825 #
4826 # In principle 32-bit x86 can support AESNI, but our implementation does not
4827 # support 32-bit x86, so we check for x86-64.
4828 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004829 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4830 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004831 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004832}
4833
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004834component_test_aesni () { # ~ 60s
4835 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4836 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4837 #
4838 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4839 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4840 # exercise the plain C impl).
4841
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004842 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004843 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004844 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004845 scripts/config.py set MBEDTLS_HAVE_ASM
4846
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004847 # test the intrinsics implementation
4848 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004849 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004850 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004851 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004852 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004853
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004854 # test the asm implementation
4855 msg "AES tests, test assembly"
4856 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004857 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004858 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004859 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004860
4861 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004862 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004863 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004864 msg "AES tests, plain C"
4865 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004866 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004867 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004868 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004869 not grep -q "AES note: using AESNI" ./programs/test/selftest
4870 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004871
4872 # test the intrinsics implementation
4873 scripts/config.py set MBEDTLS_AESNI_C
4874 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4875 msg "AES tests, test AESNI only"
4876 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004877 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004878 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4879 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004880 grep -q "AES note: using AESNI" ./programs/test/selftest
4881 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004882}
4883
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004884component_test_sha3_variations() {
4885 msg "sha3 loop unroll variations"
4886
4887 # define minimal config sufficient to test SHA3
4888 cat > include/mbedtls/mbedtls_config.h << END
4889 #define MBEDTLS_SELF_TEST
4890 #define MBEDTLS_SHA3_C
4891END
4892
4893 msg "all loops unrolled"
4894 make clean
4895 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"
4896 ./tests/test_suite_shax
4897
4898 msg "all loops rolled up"
4899 make clean
4900 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"
4901 ./tests/test_suite_shax
4902}
4903
Jerry Yub6d39c22023-08-16 15:11:48 +08004904support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004905 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004906}
4907
4908component_test_aesni_m32 () { # ~ 60s
4909 # This tests are duplicated from component_test_aesni for i386 target
4910 #
4911 # AESNI intrinsic code supports i386 and assembly code does not support it.
4912
4913 msg "build: default config with different AES implementations"
4914 scripts/config.py set MBEDTLS_AESNI_C
4915 scripts/config.py set MBEDTLS_PADLOCK_C
4916 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4917 scripts/config.py set MBEDTLS_HAVE_ASM
4918
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004919 # test the intrinsics implementation with gcc
4920 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004921 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004922 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004923 # check that we built intrinsics - this should be used by default when supported by the compiler
4924 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4925 grep -q "AES note: using AESNI" ./programs/test/selftest
4926 grep -q "AES note: built-in implementation." ./programs/test/selftest
4927 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4928 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4929
4930 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004931 scripts/config.py unset MBEDTLS_PADLOCK_C
4932 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4933 msg "AES tests, test AESNI only"
4934 make clean
4935 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4936 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4937 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4938 grep -q "AES note: using AESNI" ./programs/test/selftest
4939 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4940 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4941 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4942}
4943
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004944support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004945 # clang >= 4 is required to build with target attributes
4946 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004947}
4948
4949component_test_aesni_m32_clang() {
4950
4951 scripts/config.py set MBEDTLS_AESNI_C
4952 scripts/config.py set MBEDTLS_PADLOCK_C
4953 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4954 scripts/config.py set MBEDTLS_HAVE_ASM
4955
4956 # test the intrinsics implementation with clang
4957 msg "AES tests, test intrinsics (clang)"
4958 make clean
4959 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4960 # check that we built intrinsics - this should be used by default when supported by the compiler
4961 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4962 grep -q "AES note: using AESNI" ./programs/test/selftest
4963 grep -q "AES note: built-in implementation." ./programs/test/selftest
4964 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4965 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4966}
4967
Jerry Yu193cbc02023-08-03 17:06:29 +08004968# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4969component_build_aes_aesce_armcc () {
4970 msg "Build: AESCE test on arm64 platform without plain C."
4971 scripts/config.py baremetal
4972
4973 # armc[56] don't support SHA-512 intrinsics
4974 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4975
4976 # Stop armclang warning about feature detection for A64_CRYPTO.
4977 # With this enabled, the library does build correctly under armclang,
4978 # but in baremetal builds (as tested here), feature detection is
4979 # unavailable, and the user is notified via a #warning. So enabling
4980 # this feature would prevent us from building with -Werror on
4981 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004982 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004983 scripts/config.py set MBEDTLS_HAVE_ASM
4984
4985 msg "AESCE, build with default configuration."
4986 scripts/config.py set MBEDTLS_AESCE_C
4987 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4988 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4989
4990 msg "AESCE, build AESCE only"
4991 scripts/config.py set MBEDTLS_AESCE_C
4992 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4993 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4994}
4995
Dave Rodgman0c584032023-10-08 12:26:54 +01004996support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004997 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004998 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004999}
5000
5001component_build_aes_armce () {
5002 # Test variations of AES with Armv8 crypto extensions
5003 scripts/config.py set MBEDTLS_AESCE_C
5004 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5005
5006 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01005007 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005008
5009 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5010 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5011
5012 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5013 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5014
Dave Rodgman5e419372023-10-23 15:30:20 +01005015 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01005016
Dave Rodgman5e419372023-10-23 15:30:20 +01005017 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
5018 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005019
Dave Rodgman5e419372023-10-23 15:30:20 +01005020 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5021 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01005022
Dave Rodgman5e419372023-10-23 15:30:20 +01005023 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5024 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01005025
5026 # test for presence of AES instructions
5027 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5028 msg "clang, test A32 crypto instructions built"
5029 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5030 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5031 msg "clang, test T32 crypto instructions built"
5032 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5033 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5034 msg "clang, test aarch64 crypto instructions built"
5035 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5036 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
5037
5038 # test for absence of AES instructions
5039 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
5040 scripts/config.py unset MBEDTLS_AESCE_C
5041 msg "clang, test A32 crypto instructions not built"
5042 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5043 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5044 msg "clang, test T32 crypto instructions not built"
5045 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5046 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5047 msg "clang, test aarch64 crypto instructions not built"
5048 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5049 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01005050}
5051
Dave Rodgman9ed18532023-10-05 00:06:47 +01005052support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00005053 # clang >= 4 is required to build with SHA extensions
5054 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01005055}
5056
Dave Rodgmand9e80832023-10-04 17:17:46 +01005057component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01005058 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005059
5060
5061 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01005062 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005063 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
5064 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5065 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
5066 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5067 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005068
Dave Rodgmand9e80832023-10-04 17:17:46 +01005069
Dave Rodgman94a634d2023-10-10 12:59:29 +01005070 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005071 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005072 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
5073 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5074 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005075
Dave Rodgman5b89c552023-10-10 14:59:02 +01005076 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005077 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
5078 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5079 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01005080
Dave Rodgmancd654002023-10-05 09:40:07 +01005081
Dave Rodgman94a634d2023-10-10 12:59:29 +01005082 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005083 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005084 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
5085 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
5086 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
5087 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5088 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005089
Dave Rodgmancd654002023-10-05 09:40:07 +01005090
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005091 # examine the disassembly for presence of SHA instructions
5092 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5093 scripts/config.py set ${opt}
5094 msg "${opt} clang, test A32 crypto instructions built"
5095 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5096 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5097
5098 msg "${opt} clang, test T32 crypto instructions built"
5099 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5100 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5101
5102 msg "${opt} clang, test aarch64 crypto instructions built"
5103 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5104 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5105 scripts/config.py unset ${opt}
5106 done
5107
5108
5109 # examine the disassembly for absence of SHA instructions
5110 msg "clang, test A32 crypto instructions not built"
5111 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5112 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5113
5114 msg "clang, test T32 crypto instructions not built"
5115 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5116 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5117
5118 msg "clang, test aarch64 crypto instructions not built"
5119 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5120 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005121}
5122
Jerry Yuc935aa62023-08-03 17:08:27 +08005123# For timebeing, no VIA Padlock platform available.
5124component_build_aes_via_padlock () {
5125
5126 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005127 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005128 scripts/config.py set MBEDTLS_PADLOCK_C
5129 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005130 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005131 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005132
5133}
5134
5135support_build_aes_via_padlock_only () {
5136 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5137 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5138 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5139}
5140
Jerry Yu193cbc02023-08-03 17:06:29 +08005141support_build_aes_aesce_armcc () {
5142 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005143}
5144
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005145component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005146 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005147 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005148 scripts/config.py unset MBEDTLS_PADLOCK_C
5149
Dave Rodgmand8d64512023-12-19 12:20:21 +00005150 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005151
5152 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5153 make test
5154}
5155
5156component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5157 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5158 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005159 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5160 scripts/config.py unset MBEDTLS_PADLOCK_C
5161
Hanno Becker83ebf782017-07-07 12:29:15 +01005162 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005163
5164 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005165 make test
5166}
Gilles Peskine8f073122018-11-27 15:58:47 +01005167
Hanno Becker83ebf782017-07-07 12:29:15 +01005168component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005169 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5170 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5171 scripts/config.py unset MBEDTLS_PADLOCK_C
5172 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005173 scripts/config.py unset MBEDTLS_AESCE_C
5174
Dave Rodgmand8d64512023-12-19 12:20:21 +00005175 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005176
5177 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005178 make test
5179
5180 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5181 programs/test/selftest
5182}
5183
Matthias Schulz0767fda2024-02-07 10:46:28 +01005184component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005185 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5186 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005187 scripts/config.py unset MBEDTLS_PADLOCK_C
5188 scripts/config.py unset MBEDTLS_AESNI_C
5189 scripts/config.py unset MBEDTLS_AESCE_C
5190
5191 make CFLAGS='-O2 -Werror -Wall -Wextra'
5192
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005193 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005194 make test
5195}
5196
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005197component_test_aes_fewer_tables () {
5198 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005199 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005200 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005201
Gilles Peskine7c652162017-12-11 00:01:40 +01005202 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005203 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005204}
5205
5206component_test_aes_rom_tables () {
5207 msg "build: default config with AES_ROM_TABLES enabled"
5208 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005209 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005210
5211 msg "test: AES_ROM_TABLES"
5212 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005213}
5214
Gilles Peskine14c3c062018-01-29 21:25:12 +01005215component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005216 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5217 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5218 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005219 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005220
Gilles Peskine8f073122018-11-27 15:58:47 +01005221 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5222 make test
5223}
5224
Yanray Wang49cd4b52023-11-10 11:58:37 +08005225# helper for common_block_cipher_no_decrypt() which:
5226# - enable/disable the list of config options passed from -s/-u respectively.
5227# - build
5228# - test for tests_suite_xxx
5229# - selftest
5230#
5231# Usage: helper_block_cipher_no_decrypt_build_test
5232# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5233# Options: -s set_opts the list of config options to enable
5234# -u unset_opts the list of config options to disable
5235# -c cflags the list of options passed to CFLAGS
5236# -l ldflags the list of options passed to LDFLAGS
5237helper_block_cipher_no_decrypt_build_test () {
5238 while [ $# -gt 0 ]; do
5239 case "$1" in
5240 -s)
5241 shift; local set_opts="$1";;
5242 -u)
5243 shift; local unset_opts="$1";;
5244 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005245 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005246 -l)
5247 shift; local ldflags="$1";;
5248 esac
5249 shift
5250 done
5251 set_opts="${set_opts:-}"
5252 unset_opts="${unset_opts:-}"
5253 cflags="${cflags:-}"
5254 ldflags="${ldflags:-}"
5255
Yanray Wangb2d6e522023-11-13 16:57:47 +08005256 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5257 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005258
5259 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5260 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005261 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005262
5263 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5264 not grep mbedtls_aes_setkey_dec library/aes.o
5265 not grep mbedtls_aria_setkey_dec library/aria.o
5266 not grep mbedtls_camellia_setkey_dec library/camellia.o
5267 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5268 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005269 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5270 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005271
5272 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5273 make test
5274
5275 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5276 programs/test/selftest
5277}
5278
5279# This is a common configuration function used in:
5280# - component_test_block_cipher_no_decrypt_aesni_legacy()
5281# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5282# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5283# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5284# on x86.
5285common_block_cipher_no_decrypt () {
5286 # test AESNI intrinsics
5287 helper_block_cipher_no_decrypt_build_test \
5288 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005289 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005290
5291 # test AESNI assembly
5292 helper_block_cipher_no_decrypt_build_test \
5293 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005294 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005295
5296 # test AES C implementation
5297 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005298 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005299
5300 # test AESNI intrinsics for i386 target
5301 helper_block_cipher_no_decrypt_build_test \
5302 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005303 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005304 -l "-m32"
5305}
5306
Yanray Wang3ae11992023-11-13 17:32:09 +08005307# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5308# usage: 0: no PSA crypto configuration
5309# 1: use PSA crypto configuration
5310config_block_cipher_no_decrypt () {
5311 use_psa=$1
5312
Yanray Wang66111392023-10-31 18:54:54 +08005313 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005314 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5315 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005316 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005317 scripts/config.py unset MBEDTLS_NIST_KW_C
5318
Yanray Wang3ae11992023-11-13 17:32:09 +08005319 if [ "$use_psa" -eq 1 ]; then
5320 # Enable support for cryptographic mechanisms through the PSA API.
5321 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5322 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5323 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5324 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5325 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5326 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5327 fi
5328}
5329
5330component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005331 # This consistently causes an llvm crash on clang 3.8, so use gcc
5332 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005333 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005334 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005335}
5336
Yanray Wangf1496402023-11-01 18:55:13 +08005337component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005338 # This consistently causes an llvm crash on clang 3.8, so use gcc
5339 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005340 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005341 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005342}
5343
Yanray Wang66111392023-10-31 18:54:54 +08005344support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005345 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005346}
5347
Yanray Wang66111392023-10-31 18:54:54 +08005348component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005349 scripts/config.py baremetal
5350
5351 # armc[56] don't support SHA-512 intrinsics
5352 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5353
5354 # Stop armclang warning about feature detection for A64_CRYPTO.
5355 # With this enabled, the library does build correctly under armclang,
5356 # but in baremetal builds (as tested here), feature detection is
5357 # unavailable, and the user is notified via a #warning. So enabling
5358 # this feature would prevent us from building with -Werror on
5359 # armclang. Tracked in #7198.
5360 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5361 scripts/config.py set MBEDTLS_HAVE_ASM
5362
Yanray Wang3ae11992023-11-13 17:32:09 +08005363 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005364
5365 # test AESCE baremetal build
5366 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005367 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005368 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005369
Yanray Wangef1b04d2023-09-08 11:09:26 +08005370 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5371 not grep mbedtls_aes_setkey_dec library/aes.o
5372 not grep mbedtls_aria_setkey_dec library/aria.o
5373 not grep mbedtls_camellia_setkey_dec library/camellia.o
5374 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5375 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005376 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005377 not grep mbedtls_aesce_inverse_key library/aesce.o
5378 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005379}
5380
Gilles Peskine592f5912019-10-07 18:49:32 +02005381component_test_ctr_drbg_aes_256_sha_256 () {
5382 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5383 scripts/config.py full
5384 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5385 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005386 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005387 make
5388
5389 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5390 make test
5391}
5392
5393component_test_ctr_drbg_aes_128_sha_512 () {
5394 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005395 scripts/config.py full
5396 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5397 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005398 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005399 make
5400
5401 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5402 make test
5403}
5404
5405component_test_ctr_drbg_aes_128_sha_256 () {
5406 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005407 scripts/config.py full
5408 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5409 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5410 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005411 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005412 make
5413
5414 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5415 make test
5416}
5417
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005418component_test_se_default () {
5419 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005420 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005421 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005422
5423 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5424 make test
5425}
5426
Steven Cooremand57203d2020-07-16 20:28:59 +02005427component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005428 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005429 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005430 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005431 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5432 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005433 loc_cflags="${loc_cflags} -I../tests/include -O2"
5434
Gilles Peskine21570cf2023-12-22 11:49:50 +01005435 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005436
Gilles Peskine1997f302023-07-26 18:45:20 +02005437 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005438 make test
5439}
5440
Gilles Peskine8f073122018-11-27 15:58:47 +01005441component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005442 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005443 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005444 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005445 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005446}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005447
Gilles Peskinecf740502019-07-03 20:43:05 +02005448component_test_cmake_shared () {
5449 msg "build/test: cmake shared" # ~ 2min
5450 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5451 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005452 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005453 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005454 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005455}
5456
Gilles Peskineec10bf12019-09-20 19:56:06 +02005457test_build_opt () {
5458 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005459 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005460 for opt in "$@"; do
5461 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005462 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005463 # We're confident enough in compilers to not run _all_ the tests,
5464 # but at least run the unit tests. In particular, runs with
5465 # optimizations use inline assembly whereas runs with -O0
5466 # skip inline assembly.
5467 make test # ~30s
5468 make clean
5469 done
5470}
5471
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005472# For FreeBSD we invoke the function by name so this condition is added
5473# to disable the existing test_clang_opt function for linux.
5474if [[ $(uname) != "Linux" ]]; then
5475 component_test_clang_opt () {
5476 scripts/config.py full
5477 test_build_opt 'full config' clang -O0 -Os -O2
5478 }
5479fi
5480
5481component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005482 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005483 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005484}
5485support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005486 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005487}
5488
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005489component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005490 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005491 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005492}
5493support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005494 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005495}
5496
5497component_test_gcc_latest_opt () {
5498 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005499 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005500}
5501support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005502 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005503}
5504
5505component_test_gcc_earliest_opt () {
5506 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005507 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005508}
5509support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005510 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005511}
5512
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005513component_build_mbedtls_config_file () {
5514 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005515 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005516 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005517 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005518 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005519 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5520 make clean
5521
5522 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5523 # In the user config, disable one feature (for simplicity, pick a feature
5524 # that nothing else depends on).
5525 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005526 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005527 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5528
5529 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005530}
5531
Gilles Peskine7d904e72022-04-07 21:59:14 +02005532component_build_psa_config_file () {
5533 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5534 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5535 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5536 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5537 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005538 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005539 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5540 make clean
5541
5542 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Cron7d949ae2024-05-15 18:31:17 +02005543 # In the user config, disable one feature and its dependencies, which will
5544 # reflect on the mbedtls configuration so we can query it with
5545 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005546 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Cron7d949ae2024-05-15 18:31:17 +02005547 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005548 scripts/config.py unset MBEDTLS_CMAC_C
5549 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5550 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5551
5552 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005553}
5554
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005555component_build_psa_alt_headers () {
5556 msg "build: make with PSA alt headers" # ~20s
5557
5558 # Generate alternative versions of the substitutable headers with the
5559 # same content except different include guards.
5560 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5561
5562 # Build the library and some programs.
5563 # Don't build the fuzzers to avoid having to go through hoops to set
5564 # a correct include path for programs/fuzz/Makefile.
5565 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
5566 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\"'"
5567
5568 # Check that we're getting the alternative include guards and not the
5569 # original include guards.
5570 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5571 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5572 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5573 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5574}
5575
Dave Rodgman852de3c2023-12-14 14:46:45 +00005576component_test_m32_no_asm () {
5577 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005578 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005579 #
5580 # Note that we require gcc, because clang Asan builds fail to link for
5581 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005582 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005583 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005584 scripts/config.py unset MBEDTLS_HAVE_ASM
5585 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005586 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005587 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005588
Dave Rodgman852de3c2023-12-14 14:46:45 +00005589 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005590 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005591}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005592support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005593 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005594 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005595 *) false;;
5596 esac
5597}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005598
Gilles Peskineff0aee02021-10-05 09:36:03 +02005599component_test_m32_o2 () {
5600 # Build with optimization, to use the i386 specific inline assembly
5601 # and go faster for tests.
5602 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005603 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005604 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005605 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005606
Gilles Peskineff0aee02021-10-05 09:36:03 +02005607 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005608 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005609
Gilles Peskineff0aee02021-10-05 09:36:03 +02005610 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005611 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005612}
Gilles Peskinecf522222021-10-07 19:25:29 +02005613support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005614 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005615}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005616
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005617component_test_m32_everest () {
5618 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005619 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005620 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005621 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005622
5623 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5624 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005625
5626 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005627 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005628
5629 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5630 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005631 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005632}
5633support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005634 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005635}
5636
Gilles Peskine8f073122018-11-27 15:58:47 +01005637component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005638 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005639 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005640 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005641
5642 msg "test: 64-bit ILP32, make, gcc"
5643 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005644}
Gilles Peskine878cf602019-01-06 20:50:38 +00005645support_test_mx32 () {
5646 case $(uname -m) in
5647 amd64|x86_64) true;;
5648 *) false;;
5649 esac
5650}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005651
Peter Kolbus60c6da22018-12-27 06:59:04 -06005652component_test_min_mpi_window_size () {
5653 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005654 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005655 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005656 make
5657
5658 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5659 make test
5660}
5661
Gilles Peskine8f073122018-11-27 15:58:47 +01005662component_test_have_int32 () {
5663 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005664 scripts/config.py unset MBEDTLS_HAVE_ASM
5665 scripts/config.py unset MBEDTLS_AESNI_C
5666 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005667 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005668 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005669
Gilles Peskine8f073122018-11-27 15:58:47 +01005670 msg "test: gcc, force 32-bit bignum limbs"
5671 make test
5672}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005673
Gilles Peskine8f073122018-11-27 15:58:47 +01005674component_test_have_int64 () {
5675 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005676 scripts/config.py unset MBEDTLS_HAVE_ASM
5677 scripts/config.py unset MBEDTLS_AESNI_C
5678 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005679 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005680 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005681
Gilles Peskine8f073122018-11-27 15:58:47 +01005682 msg "test: gcc, force 64-bit bignum limbs"
5683 make test
5684}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005685
Gabor Mezeie256cc12023-07-26 17:28:48 +02005686component_test_have_int32_cmake_new_bignum () {
5687 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5688 scripts/config.py unset MBEDTLS_HAVE_ASM
5689 scripts/config.py unset MBEDTLS_AESNI_C
5690 scripts/config.py unset MBEDTLS_PADLOCK_C
5691 scripts/config.py unset MBEDTLS_AESCE_C
5692 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005693 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005694 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005695
5696 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5697 make test
5698}
5699
Gilles Peskine8f073122018-11-27 15:58:47 +01005700component_test_no_udbl_division () {
5701 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005702 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005703 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005704 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005705
Gilles Peskine8f073122018-11-27 15:58:47 +01005706 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5707 make test
5708}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005709
Gilles Peskine8f073122018-11-27 15:58:47 +01005710component_test_no_64bit_multiplication () {
5711 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005712 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005713 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005714 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005715
Gilles Peskine8f073122018-11-27 15:58:47 +01005716 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5717 make test
5718}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005719
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005720component_test_no_strings () {
5721 msg "build: no strings" # ~10s
5722 scripts/config.py full
5723 # Disable options that activate a large amount of string constants.
5724 scripts/config.py unset MBEDTLS_DEBUG_C
5725 scripts/config.py unset MBEDTLS_ERROR_C
5726 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5727 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005728 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005729
5730 msg "test: no strings" # ~ 10s
5731 make test
5732}
5733
Hanno Beckerc5722d12020-10-09 11:10:42 +01005734component_test_no_x509_info () {
5735 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5736 scripts/config.pl full
5737 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5738 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005739 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005740
5741 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5742 make test
5743
5744 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005745 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005746}
5747
Gilles Peskine8f073122018-11-27 15:58:47 +01005748component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005749 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005750 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005751 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 +02005752
Gilles Peskinee36fe812021-09-01 20:00:33 +02005753 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005754 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005755}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005756
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005757component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005758 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005759 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005760 # Build for a target platform that's close to what Debian uses
5761 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005762 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005763 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005764 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005765 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'
5766
Gilles Peskinee36fe812021-09-01 20:00:33 +02005767 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005768 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005769}
5770support_build_arm_linux_gnueabi_gcc_arm5vte () {
5771 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5772}
5773
5774component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005775 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005776 scripts/config.py baremetal
5777 # This is an imperfect substitute for
5778 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005779 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005780 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 +02005781
Gilles Peskinee36fe812021-09-01 20:00:33 +02005782 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005783 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005784}
5785
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005786component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005787 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5788 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005789 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 +02005790
Gilles Peskinee36fe812021-09-01 20:00:33 +02005791 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005792 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005793 for lib in library/*.a; do
5794 echo "$lib:"
5795 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5796 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005797}
5798
Gilles Peskine8f073122018-11-27 15:58:47 +01005799component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005800 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005801 scripts/config.py baremetal
5802 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005803 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 +01005804 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005805 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005806}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005807
Gilles Peskine8f073122018-11-27 15:58:47 +01005808component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005809 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005810 scripts/config.py baremetal
5811 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005812 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 +01005813 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005814 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005815}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005816
Dave Rodgman8c315f22023-06-02 10:26:24 -04005817component_build_arm_clang_thumb () {
5818 # ~ 30s
5819
5820 scripts/config.py baremetal
5821
5822 msg "build: clang thumb 2, make"
5823 make clean
5824 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5825
5826 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5827 msg "build: clang thumb 1 -O0, make"
5828 make clean
5829 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5830
5831 msg "build: clang thumb 1 -Os, make"
5832 make clean
5833 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5834}
5835
Gilles Peskine8f073122018-11-27 15:58:47 +01005836component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005837 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005838 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005839 # armc[56] don't support SHA-512 intrinsics
5840 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005841
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005842 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5843 scripts/config.py unset MBEDTLS_AESCE_C
5844
Dave Rodgman0fddf822023-03-02 15:32:12 +00005845 # Stop armclang warning about feature detection for A64_CRYPTO.
5846 # With this enabled, the library does build correctly under armclang,
5847 # but in baremetal builds (as tested here), feature detection is
5848 # unavailable, and the user is notified via a #warning. So enabling
5849 # this feature would prevent us from building with -Werror on
5850 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005851 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005852
Hanno Beckerf0762e92022-07-15 12:08:19 +01005853 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005854
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005855 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005856
5857 msg "size: ARM Compiler 5"
5858 "$ARMC5_FROMELF" -z library/*.o
5859
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005860 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005861
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005862 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005863 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005864
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005865 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005866 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5867
5868 # ARM Compiler 6 - Target ARMv7-M+DSP
5869 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005870
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005871 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005872 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005873
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005874 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005875 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005876
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005877 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5878 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5879
Dave Rodgman99318e62023-05-24 12:27:42 +01005880 # ARM Compiler 6 - Target Cortex-M0
5881 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005882
5883 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5884 #
5885 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5886 # that we have in our CI
5887 scripts/config.py set MBEDTLS_AESCE_C
5888 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005889}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005890
Pengyu Lvdf070032023-02-24 16:03:31 +08005891support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005892 armc5_cc="$ARMC5_BIN_DIR/armcc"
5893 armc6_cc="$ARMC6_BIN_DIR/armclang"
5894 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005895}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005896
Ronald Crond2cb7f42024-03-18 12:49:18 +01005897component_test_tls12_only () {
5898 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5899 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5900 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5901 make
5902
5903 msg "test: main suites (inc. selftests) (ASan build)"
5904 make test
5905
5906 msg "test: ssl-opt.sh (ASan build)"
5907 tests/ssl-opt.sh
5908
5909 msg "test: compat.sh (ASan build)"
5910 tests/compat.sh
5911}
5912
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005913component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005914 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005915 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005916 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005917 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5918
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005919 msg "test: TLS 1.3 only, all key exchange modes enabled"
5920 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005921
Ronald Cronc3f43b62022-10-17 17:35:32 +02005922 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5923 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005924}
5925
Ronald Cronc3f43b62022-10-17 17:35:32 +02005926component_test_tls13_only_psk () {
5927 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5928 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5929 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5930 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005931 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005932 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5933 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5934 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5935 scripts/config.py unset MBEDTLS_ECDSA_C
5936 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005937 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005938 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005939 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5940
Ronald Cronc3f43b62022-10-17 17:35:32 +02005941 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5942 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005943
Ronald Cronc3f43b62022-10-17 17:35:32 +02005944 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5945 tests/ssl-opt.sh
5946}
5947
5948component_test_tls13_only_ephemeral () {
5949 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5950 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5951 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005952 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005953 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5954
5955 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5956 cd tests; ./test_suite_ssl; cd ..
5957
5958 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5959 tests/ssl-opt.sh
5960}
5961
Przemek Stekiela01c2422023-06-13 10:46:48 +02005962component_test_tls13_only_ephemeral_ffdh () {
5963 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5964 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5965 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5966 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005967 scripts/config.py unset MBEDTLS_ECDH_C
5968
Przemek Stekiela01c2422023-06-13 10:46:48 +02005969 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5970
5971 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5972 cd tests; ./test_suite_ssl; cd ..
5973
5974 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5975 tests/ssl-opt.sh
5976}
5977
Ronald Cronc3f43b62022-10-17 17:35:32 +02005978component_test_tls13_only_psk_ephemeral () {
5979 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5980 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5981 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5982 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5983 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5984 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5985 scripts/config.py unset MBEDTLS_ECDSA_C
5986 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005987 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005988 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005989 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5990
5991 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5992 cd tests; ./test_suite_ssl; cd ..
5993
5994 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5995 tests/ssl-opt.sh
5996}
5997
Przemek Stekiela01c2422023-06-13 10:46:48 +02005998component_test_tls13_only_psk_ephemeral_ffdh () {
5999 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
6000 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
6001 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6002 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6003 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6004 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6005 scripts/config.py unset MBEDTLS_ECDSA_C
6006 scripts/config.py unset MBEDTLS_PKCS1_V21
6007 scripts/config.py unset MBEDTLS_PKCS7_C
6008 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02006009 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02006010 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6011
6012 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6013 cd tests; ./test_suite_ssl; cd ..
6014
6015 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6016 tests/ssl-opt.sh
6017}
6018
Ronald Cronc3f43b62022-10-17 17:35:32 +02006019component_test_tls13_only_psk_all () {
6020 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
6021 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6022 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6023 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6024 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6025 scripts/config.py unset MBEDTLS_ECDSA_C
6026 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00006027 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01006028 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006029 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6030
6031 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6032 cd tests; ./test_suite_ssl; cd ..
6033
6034 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6035 tests/ssl-opt.sh
6036}
6037
6038component_test_tls13_only_ephemeral_all () {
6039 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
6040 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01006041 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006042 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6043
6044 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6045 cd tests; ./test_suite_ssl; cd ..
6046
6047 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6048 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02006049}
6050
Ronald Cron46ac0652024-03-18 12:39:04 +01006051component_test_tls13_no_padding () {
6052 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006053 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01006054 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006055 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006056 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006057 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006058 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01006059 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006060 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006061}
6062
Ronald Cron6f135e12021-12-08 16:57:54 +01006063component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01006064 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006065 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01006066 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006067 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01006068 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006069 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006070 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01006071 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006072 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006073}
6074
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006075component_test_full_minus_session_tickets() {
6076 msg "build: full config without session tickets"
6077 scripts/config.py full
Norbert Fabritius06d99342023-04-11 15:40:05 +02006078 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006079 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritius06d99342023-04-11 15:40:05 +02006080 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
6081 make
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006082 msg "test: full config without session tickets"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006083 make test
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006084 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006085 tests/ssl-opt.sh
6086}
6087
Gilles Peskine8f073122018-11-27 15:58:47 +01006088component_build_mingw () {
6089 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006090 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 +00006091
Gilles Peskine8f073122018-11-27 15:58:47 +01006092 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006093 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 +01006094 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02006095
Gilles Peskine8f073122018-11-27 15:58:47 +01006096 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006097 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
6098 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 +01006099 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006100
Pengyu Lv158eead2023-10-19 11:27:05 +08006101 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006102 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08006103 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 +01006104 make WINDOWS_BUILD=1 clean
6105}
Jaeden Amero117b8a42019-04-17 15:19:26 +01006106support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08006107 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
6108 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01006109 *) true;;
6110 esac
6111}
Simon Butcher91aef332016-11-17 09:20:50 +00006112
Gilles Peskine8f073122018-11-27 15:58:47 +01006113component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006114 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02006115 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006116 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6117 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006118
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006119 msg "test: main suites (MSan)" # ~ 10s
6120 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006121
Gilles Peskine6848d172023-11-02 19:58:03 +01006122 msg "test: metatests (MSan)"
6123 tests/scripts/run-metatests.sh any msan
6124
Gilles Peskine82b27272019-06-14 18:27:03 +02006125 msg "program demos (MSan)" # ~20s
6126 tests/scripts/run_demos.py
6127
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006128 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006129 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006130
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006131 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006132
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006133 if [ "$MEMORY" -gt 0 ]; then
6134 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006135 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006136 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006137}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006138
Bence Szépkúti0354d042023-12-06 16:14:37 +01006139component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006140 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006141 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006142 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6143 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006144
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006145 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006146 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006147
Gilles Peskine636c26a2020-03-04 20:46:15 +01006148 # Optional parts (slow; currently broken on OS X because programs don't
6149 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006150 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006151 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006152 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006153 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006154 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006155
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006156 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006157 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006158 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006159 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006160
6161 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006162 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006163 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006164 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006165}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006166
Bence Szépkúti0354d042023-12-06 16:14:37 +01006167component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006168 msg "build: Release, full (clang)"
6169 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6170 scripts/config.py full
6171 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6172 make
6173
6174 msg "test: main suites, Valgrind (full config)"
6175 make memcheck
6176}
6177
Paul Elliott62dc3922021-11-25 17:29:40 +00006178support_test_cmake_out_of_source () {
6179 distrib_id=""
6180 distrib_ver=""
6181 distrib_ver_minor=""
6182 distrib_ver_major=""
6183
6184 # Attempt to parse lsb-release to find out distribution and version. If not
6185 # found this should fail safe (test is supported).
6186 if [[ -f /etc/lsb-release ]]; then
6187
6188 while read -r lsb_line; do
6189 case "$lsb_line" in
6190 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6191 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6192 esac
6193 done < /etc/lsb-release
6194
6195 distrib_ver_major="${distrib_ver%%.*}"
6196 distrib_ver="${distrib_ver#*.}"
6197 distrib_ver_minor="${distrib_ver%%.*}"
6198 fi
6199
6200 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6201 # processor (as the CI does) can create a race condition whereby the build
6202 # fails to see a generated file, despite that file actually having been
6203 # generated. This problem appears to go away with 18.04 or newer, so make
6204 # the out of source tests unsupported on Ubuntu 16.04.
6205 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6206}
6207
Gilles Peskine8f073122018-11-27 15:58:47 +01006208component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006209 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006210 # generates
6211 make neat
6212
Gilles Peskine8f073122018-11-27 15:58:47 +01006213 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006214 MBEDTLS_ROOT_DIR="$PWD"
6215 mkdir "$OUT_OF_SOURCE_DIR"
6216 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006217 # Note: Explicitly generate files as these are turned off in releases
6218 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006219 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006220
Gilles Peskine8f073122018-11-27 15:58:47 +01006221 msg "test: cmake 'out-of-source' build"
6222 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006223 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006224 # Also ensure that there are no error messages such as
6225 # "No such file or directory", which would indicate that some required
6226 # file is missing (ssl-opt.sh tolerates the absence of some files so
6227 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006228 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006229 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006230 cat ssl-opt.err >&2
6231 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006232 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006233 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006234 cd "$MBEDTLS_ROOT_DIR"
6235 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006236}
Andres AGdc192212016-08-31 17:33:13 +01006237
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006238component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006239 # Remove existing generated files so that we use the ones CMake
6240 # generates
6241 make neat
6242
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006243 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006244 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006245 # Note: Explicitly generate files as these are turned off in releases
6246 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006247 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006248 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006249}
Gilles Peskinea3000992022-02-04 00:21:12 +01006250support_test_cmake_as_subdirectory () {
6251 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006252}
6253
Chris Kayd259e342021-03-25 16:03:25 +00006254component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006255 # Remove existing generated files so that we use the ones CMake
6256 # generates
6257 make neat
6258
Chris Kayd259e342021-03-25 16:03:25 +00006259 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006260 cd programs/test/cmake_package
6261 cmake .
6262 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006263 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006264}
Gilles Peskinea3000992022-02-04 00:21:12 +01006265support_test_cmake_as_package () {
6266 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006267}
6268
6269component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006270 # Remove existing generated files so that we use the ones CMake
6271 # generates
6272 make neat
6273
Chris Kayd259e342021-03-25 16:03:25 +00006274 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006275 cd programs/test/cmake_package_install
6276 cmake .
6277 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006278 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006279}
Gilles Peskinea3000992022-02-04 00:21:12 +01006280support_test_cmake_as_package_install () {
6281 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006282}
6283
David Horstmann20550e32023-01-12 14:17:01 +00006284component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006285 # Make a copy of config file to use for the in-tree test
6286 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006287
6288 MBEDTLS_ROOT_DIR="$PWD"
6289 mkdir "$OUT_OF_SOURCE_DIR"
6290 cd "$OUT_OF_SOURCE_DIR"
6291
David Horstmann969c1452023-01-31 10:34:44 +00006292 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006293 cmake "$MBEDTLS_ROOT_DIR"
6294 make
6295
6296 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6297 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006298 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006299 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6300 make
6301
6302 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6303 # In the user config, disable one feature (for simplicity, pick a feature
6304 # that nothing else depends on).
6305 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6306
6307 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6308 make
6309 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6310
6311 rm -f user_config.h full_config.h
6312
6313 cd "$MBEDTLS_ROOT_DIR"
6314 rm -rf "$OUT_OF_SOURCE_DIR"
6315
6316 # Now repeat the test for an in-tree build:
6317
David Horstmann969c1452023-01-31 10:34:44 +00006318 # Restore config for the in-tree test
6319 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006320
David Horstmann969c1452023-01-31 10:34:44 +00006321 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006322 cmake .
6323 make
6324
6325 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6326 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006327 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006328 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6329 make
6330
6331 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6332 # In the user config, disable one feature (for simplicity, pick a feature
6333 # that nothing else depends on).
6334 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6335
6336 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6337 make
6338 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6339
6340 rm -f user_config.h full_config.h
6341}
6342support_build_cmake_custom_config_file () {
6343 support_test_cmake_out_of_source
6344}
6345
David Horstmann90dddc62024-05-10 14:37:48 +01006346component_build_cmake_programs_no_testing () {
David Horstmanndf097d32024-05-10 15:37:57 +01006347 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann90dddc62024-05-10 14:37:48 +01006348 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6349 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6350 make
6351}
6352support_build_cmake_programs_no_testing () {
6353 support_test_cmake_out_of_source
6354}
David Horstmann20550e32023-01-12 14:17:01 +00006355
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006356component_build_zeroize_checks () {
6357 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6358
6359 scripts/config.py full
6360
6361 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006362 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 +01006363}
6364
6365
Gilles Peskine8f073122018-11-27 15:58:47 +01006366component_test_zeroize () {
6367 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6368 # different combinations of compilers and optimization flags by using an
6369 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6370 # system in all cases that the script fails, so we must manually search the
6371 # output to check whether the pass string is present and no failure strings
6372 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006373
Gilles Peskine4976e822019-01-06 19:52:22 +00006374 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6375 # about a spurious message if Gdb tries and fails, so suppress that.
6376 gdb_disable_aslr=
6377 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6378 gdb_disable_aslr='set disable-randomization off'
6379 fi
6380
Gilles Peskine8f073122018-11-27 15:58:47 +01006381 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006382 for compiler in clang gcc; do
6383 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6384 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006385 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6386 grep "The buffer was correctly zeroized" test_zeroize.log
6387 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006388 rm -f test_zeroize.log
6389 make clean
6390 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006391 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006392}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006393
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006394component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006395 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006396 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006397 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006398
6399 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006400 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006401}
6402
6403support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006404 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006405 ver="$(cmake --version)"
6406 ver="${ver#cmake version }"
6407 ver_major="${ver%%.*}"
6408
6409 ver="${ver#*.}"
6410 ver_minor="${ver%%.*}"
6411
6412 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006413}
6414
Gilles Peskinec848d222022-12-09 12:23:35 +01006415component_check_code_style () {
6416 msg "Check C code style"
6417 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006418}
6419
Gilles Peskinec848d222022-12-09 12:23:35 +01006420support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006421 case $(uncrustify --version) in
6422 *0.75.1*) true;;
6423 *) false;;
6424 esac
6425}
6426
Gilles Peskine8f073122018-11-27 15:58:47 +01006427component_check_python_files () {
6428 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006429 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006430}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006431
Joe Subbianid614c0b2021-07-29 11:18:29 +01006432component_check_test_helpers () {
6433 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006434 # unittest writes out mundane stuff like number or tests run on stderr.
6435 # Our convention is to reserve stderr for actual errors, and write
6436 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006437 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006438
Joe Subbiania25ffab2021-08-06 09:41:27 +01006439 msg "unit test: translate_ciphers.py"
6440 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006441}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006442
Jerry Yud767cc42023-03-31 15:03:55 +08006443
Gilles Peskine192c72f2017-12-21 15:59:21 +01006444################################################################
6445#### Termination
6446################################################################
6447
Gilles Peskine8f073122018-11-27 15:58:47 +01006448post_report () {
6449 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006450 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006451
Gilles Peskine8f073122018-11-27 15:58:47 +01006452 final_report
6453}
6454
6455
6456
6457################################################################
6458#### Run all the things
6459################################################################
6460
Gilles Peskine5d996822020-03-28 21:09:21 +01006461# Function invoked by --error-test to test error reporting.
6462pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006463 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006464 if [ $KEEP_GOING -ne 0 ]; then
6465 echo "Expect three failing commands."
6466 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006467 # If the component doesn't run in a subshell, changing error_test_i to an
6468 # invalid integer will cause an error in the loop that runs this function.
6469 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006470 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006471 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006472 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006473 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006474 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006475 make unknown_target
6476 false "this should not be executed"
6477}
6478
Gilles Peskinee48351a2018-11-27 16:06:30 +01006479# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006480run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006481 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006482 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006483
6484 # Unconditionally create a seedfile that's sufficiently long.
6485 # Do this before each component, because a previous component may
6486 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006487 local dd_cmd
6488 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6489 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006490 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006491 esac
6492 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006493
Gilles Peskineec135542021-08-02 23:14:03 +02006494 # Run the component in a subshell, with error trapping and output
6495 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006496 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006497 # We want to keep running if the subshell fails, so 'set -e' must
6498 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006499 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006500 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006501 (
6502 if [ $QUIET -eq 1 ]; then
6503 # msg() will be silenced, so just print the component name here.
6504 echo "${current_component#component_}"
6505 exec >/dev/null
6506 fi
6507 if [ $KEEP_GOING -eq 1 ]; then
6508 # Keep "set -e" off, and run an ERR trap instead to record failures.
6509 set -E
6510 trap err_trap ERR
6511 fi
6512 # The next line is what runs the component
6513 "$@"
6514 if [ $KEEP_GOING -eq 1 ]; then
6515 trap - ERR
6516 exit $last_failure_status
6517 fi
6518 )
6519 component_status=$?
6520 if [ $KEEP_GOING -eq 1 ]; then
6521 set -e
6522 if [ $component_status -ne 0 ]; then
6523 failure_count=$((failure_count + 1))
6524 fi
6525 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006526
6527 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006528 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006529 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006530}
6531
6532# Preliminary setup
6533pre_check_environment
6534pre_initialize_variables
6535pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006536
Dave Rodgman21900632024-02-26 11:41:19 +00006537setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006538pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006539pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006540pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006541
Gilles Peskine878cf602019-01-06 20:50:38 +00006542build_status=0
6543if [ $KEEP_GOING -eq 1 ]; then
6544 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006545fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006546pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006547pre_print_configuration
6548pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006549cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006550if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006551 pre_generate_files
6552fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006553
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006554# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006555for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006556 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006557done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006558unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006559for component in $RUN_COMPONENTS; do
6560 run_component "component_$component"
6561done
Gilles Peskine8f073122018-11-27 15:58:47 +01006562
6563# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006564post_report