blob: d13456de7c15548b4387ea4b961f0cf345f92a9a [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 {} \+
Ronald Cronda224022024-06-12 10:04:22 +0200330 # Remove Makefiles generated by in-tree CMake builds
331 rm -f 3rdparty/Makefile 3rdparty/*/Makefile pkgconfig/Makefile framework/Makefile
332 rm -f include/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200333
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100334 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
335 rm -rf programs/test/cmake_subproject/build
336 rm -f programs/test/cmake_subproject/Makefile
337 rm -f programs/test/cmake_subproject/cmake_subproject
338
Chris Kayd259e342021-03-25 16:03:25 +0000339 # Remove any artifacts from the component_test_cmake_as_package test.
340 rm -rf programs/test/cmake_package/build
341 rm -f programs/test/cmake_package/Makefile
342 rm -f programs/test/cmake_package/cmake_package
343
344 # Remove any artifacts from the component_test_cmake_as_installed_package test.
345 rm -rf programs/test/cmake_package_install/build
346 rm -f programs/test/cmake_package_install/Makefile
347 rm -f programs/test/cmake_package_install/cmake_package_install
348
Gilles Peskinef83eb822020-03-30 20:11:39 +0200349 # Restore files that may have been clobbered by the job
350 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200351 if [[ -e "$x$backup_suffix" ]]; then
352 cp -p "$x$backup_suffix" "$x"
353 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200354 done
355}
John Durkopbd069d32020-10-31 22:14:03 -0700356
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200357# Final cleanup when this script exits (except when exiting on a failure
358# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200359final_cleanup () {
360 cleanup
361
362 for x in $files_to_back_up; do
363 rm -f "$x$backup_suffix"
364 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100365}
366
Gilles Peskine7c652162017-12-11 00:01:40 +0100367# Executed on exit. May be redefined depending on command line options.
368final_report () {
369 :
370}
371
372fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200373 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100374 final_report $1
375 trap - $1
376 kill -$1 $$
377}
378
379trap 'fatal_signal HUP' HUP
380trap 'fatal_signal INT' INT
381trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200382
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200383# Number of processors on this machine. Used as the default setting
384# for parallel make.
385all_sh_nproc ()
386{
387 {
388 nproc || # Linux
389 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
390 sysctl -n hw.ncpu || # FreeBSD
391 echo 1
392 } 2>/dev/null
393}
394
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100395msg()
396{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100397 if [ -n "${current_component:-}" ]; then
398 current_section="${current_component#component_}: $1"
399 else
400 current_section="$1"
401 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200402
403 if [ $QUIET -eq 1 ]; then
404 return
405 fi
406
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100407 echo ""
408 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100409 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000410 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100411 echo "******************************************************************"
412}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100413
Gilles Peskine8f073122018-11-27 15:58:47 +0100414armc6_build_test()
415{
416 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100417
Gilles Peskine18487f62020-04-30 23:11:54 +0200418 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800419 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100420 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000421 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200422
423 msg "size: ARM Compiler 6 ($FLAGS)"
424 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100425}
Andres AGa5cd9732016-10-17 15:23:10 +0100426
Andres AGd9eba4b2016-08-26 14:42:14 +0100427err_msg()
428{
429 echo "$1" >&2
430}
431
432check_tools()
433{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200434 for tool in "$@"; do
435 if ! `type "$tool" >/dev/null 2>&1`; then
436 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100437 exit 1
438 fi
439 done
440}
441
Gilles Peskine8f073122018-11-27 15:58:47 +0100442pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000443 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100444 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100445 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100446 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200447 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000448 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100449
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000450 # Note that legacy options are ignored instead of being omitted from this
451 # list of options, so invocations that worked with previous version of
452 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100453 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100454 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200455 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200456 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200457 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000458 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100459 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
460 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100461 --clang-earliest) shift; CLANG_EARLIEST="$1";;
462 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100463 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000464 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100465 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100466 --gcc-earliest) shift; GCC_EARLIEST="$1";;
467 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100468 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200469 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
470 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100471 --gnutls-serv) shift; GNUTLS_SERV="$1";;
472 --help|-h) usage; exit;;
473 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000474 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100475 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100476 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200477 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000478 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100479 --no-force) FORCE=0;;
480 --no-keep-going) KEEP_GOING=0;;
481 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200482 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100484 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200485 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200487 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100488 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200489 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200490 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100491 --seed|-s) shift; SEED="$1";;
492 -*)
493 echo >&2 "Unknown option: $1"
494 echo >&2 "Run $0 --help for usage."
495 exit 120
496 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000497 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100498 esac
499 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100500 done
SimonB2e23c822016-04-16 21:54:39 +0100501
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100502 # Exclude components that are not supported on this platform.
503 SUPPORTED_COMPONENTS=
504 for component in $ALL_COMPONENTS; do
505 case $(type "support_$component" 2>&1) in
506 *' function'*)
507 if ! support_$component; then continue; fi;;
508 esac
509 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
510 done
511
512 if [ $list_components -eq 1 ]; then
513 printf '%s\n' $SUPPORTED_COMPONENTS
514 exit
515 fi
516
Gilles Peskinea28db922019-01-10 00:05:18 +0100517 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200518 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000519 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100520 fi
521
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000522 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
523 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100524 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000525 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100526 fi
SimonB2e23c822016-04-16 21:54:39 +0100527
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200528 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100529 if [ $all_except -eq 0 ]; then
530 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200531 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
532 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200533 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100534 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200535 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200536 # If the requested name includes a wildcard character, don't
537 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100538 case $component in
539 *[*?\[]*) continue;;
540 esac
541 case " $SUPPORTED_COMPONENTS " in
542 *" $component "*) :;;
543 *)
544 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
545 unsupported=$((unsupported + 1));;
546 esac
547 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200548 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100549 if [ $unsupported -ne 0 ]; then
550 exit 2
551 fi
552 fi
553
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000554 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100555 RUN_COMPONENTS=
556 for component in $SUPPORTED_COMPONENTS; do
557 if is_component_included "$component"; [ $? -eq $all_except ]; then
558 RUN_COMPONENTS="$RUN_COMPONENTS $component"
559 fi
560 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000561
562 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000563 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100564}
SimonB2e23c822016-04-16 21:54:39 +0100565
Gilles Peskine8f073122018-11-27 15:58:47 +0100566pre_check_git () {
567 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100568 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100569 git checkout-index -f -q $CONFIG_H
570 cleanup
571 else
SimonB2e23c822016-04-16 21:54:39 +0100572
Gilles Peskine8f073122018-11-27 15:58:47 +0100573 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
574 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
575 echo "You can either delete this directory manually, or force the test by rerunning"
576 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
577 exit 1
578 fi
579
Ronald Cron7a93ac52023-07-20 09:49:12 +0200580 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100581 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100582 echo "You can either delete or preserve your work, or force the test by rerunning the"
583 echo "script as: $0 --force"
584 exit 1
585 fi
SimonB2e23c822016-04-16 21:54:39 +0100586 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500587}
588
Gilles Peskine568f53a2021-07-12 18:16:01 +0200589pre_restore_files () {
590 # If the makefiles have been generated by a framework such as cmake,
591 # restore them from git. If the makefiles look like modifications from
592 # the ones checked into git, take care not to modify them. Whatever
593 # this function leaves behind is what the script will restore before
594 # each component.
595 case "$(head -n1 Makefile)" in
596 *[Gg]enerated*)
597 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
598 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
599 ;;
600 esac
601}
602
Gilles Peskinef83eb822020-03-30 20:11:39 +0200603pre_back_up () {
604 for x in $files_to_back_up; do
605 cp -p "$x" "$x$backup_suffix"
606 done
607}
608
Gilles Peskine8f073122018-11-27 15:58:47 +0100609pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100610 failure_count=0 # Number of failed components
611 last_failure_status=0 # Last failure status in this component
612
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100613 # See err_trap
614 previous_failure_status=0
615 previous_failed_command=
616 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100617 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100618
Gilles Peskine7c652162017-12-11 00:01:40 +0100619 start_red=
620 end_color=
621 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100622 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100623 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
624 start_red=$(printf '\033[31m')
625 end_color=$(printf '\033[0m')
626 ;;
627 esac
628 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100629
630 # Keep a summary of failures in a file. We'll print it out at the end.
631 failure_summary_file=$PWD/all-sh-failures-$$.log
632 : >"$failure_summary_file"
633
634 # Whether it makes sense to keep a component going after the specified
635 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200636 # This function normally receives the failing simple command
637 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
638 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100639 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200640 # False positives result in running things that can't be expected to
641 # work. False negatives result in things not running after something else
642 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100643 can_keep_going_after_failure () {
644 case "$1" in
645 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200646 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100647 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200648 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
649 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
650 *make*check*) true;;
651 "grep "*) true;;
652 "[ "*) true;;
653 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100654 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100655 esac
656 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100657
658 # This function runs if there is any error in a component.
659 # It must either exit with a nonzero status, or set
660 # last_failure_status to a nonzero value.
661 err_trap () {
662 # Save $? (status of the failing command). This must be the very
663 # first thing, before $? is overridden.
664 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100665 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100666
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100667 if [[ $last_failure_status -eq $previous_failure_status &&
668 "$failed_command" == "$previous_failed_command" &&
669 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
670 then
671 # The same command failed twice in a row, but this time one level
672 # less deep in the function call stack. This happens when the last
673 # command of a function returns a nonzero status, and the function
674 # returns that same status. Ignore the second failure.
675 previous_failure_funcall_depth=${#FUNCNAME[@]}
676 return
677 fi
678 previous_failure_status=$last_failure_status
679 previous_failed_command=$failed_command
680 previous_failure_funcall_depth=${#FUNCNAME[@]}
681
Gilles Peskinece266c42020-03-28 18:50:43 +0100682 text="$current_section: $failed_command -> $last_failure_status"
683 echo "${start_red}^^^^$text^^^^${end_color}" >&2
684 echo "$text" >>"$failure_summary_file"
685
686 # If the command is fatal (configure or build command), stop this
687 # component. Otherwise (test command) keep the component running
688 # (run more tests from the same build).
689 if ! can_keep_going_after_failure "$failed_command"; then
690 exit $last_failure_status
691 fi
692 }
693
Gilles Peskine7c652162017-12-11 00:01:40 +0100694 final_report () {
695 if [ $failure_count -gt 0 ]; then
696 echo
697 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100698 echo "${start_red}FAILED: $failure_count components${end_color}"
699 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100700 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
701 elif [ -z "${1-}" ]; then
702 echo "SUCCESS :)"
703 fi
704 if [ -n "${1-}" ]; then
705 echo "Killed by SIG$1."
706 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100707 rm -f "$failure_summary_file"
708 if [ $failure_count -gt 0 ]; then
709 exit 1
710 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100711 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100712}
713
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200714# record_status() and if_build_succeeded() are kept temporarily for backward
715# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100716record_status () {
717 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100718}
Gilles Peskine7c652162017-12-11 00:01:40 +0100719if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100720 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100721}
722
Gilles Peskinea681c592020-03-28 21:27:40 +0100723# '! true' does not trigger the ERR trap. Arrange to trigger it, with
724# a reasonably informative error message (not just "$@").
725not () {
726 if "$@"; then
727 report_failed_command="! $*"
728 false
729 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200730 fi
731}
732
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200733pre_prepare_outcome_file () {
734 case "$MBEDTLS_TEST_OUTCOME_FILE" in
735 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
736 esac
737 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
738 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
739 fi
740}
741
Gilles Peskine8f073122018-11-27 15:58:47 +0100742pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200743 if [ $QUIET -eq 1 ]; then
744 return
745 fi
746
Gilles Peskine8f073122018-11-27 15:58:47 +0100747 msg "info: $0 configuration"
748 echo "MEMORY: $MEMORY"
749 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200750 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100751 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100752 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100754 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
755 echo "GNUTLS_CLI: $GNUTLS_CLI"
756 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100757 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
758 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
759}
Andres AG7770ea82016-10-10 15:46:20 +0100760
Andres AGd9eba4b2016-08-26 14:42:14 +0100761# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100762pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000763 # Build the list of variables to pass to output_env.sh.
764 set env
SimonB2e23c822016-04-16 21:54:39 +0100765
Gilles Peskine87964262019-01-06 22:40:00 +0000766 case " $RUN_COMPONENTS " in
767 # Require OpenSSL and GnuTLS if running any tests (as opposed to
768 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
769 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100770 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000771 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
772 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100773 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000774 export GNUTLS_CLI="$GNUTLS_CLI"
775 export GNUTLS_SERV="$GNUTLS_SERV"
776 # Avoid passing --seed flag in every call to ssl-opt.sh
777 if [ -n "${SEED-}" ]; then
778 export SEED
779 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200780 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000781 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200782 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
783 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000784 ;;
785 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200786
Gilles Peskine87964262019-01-06 22:40:00 +0000787 case " $RUN_COMPONENTS " in
788 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
789 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100790
Gilles Peskine87964262019-01-06 22:40:00 +0000791 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200792 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000793 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100794
Gilles Peskine87964262019-01-06 22:40:00 +0000795 case " $RUN_COMPONENTS " in
796 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
797 esac
798
799 case " $RUN_COMPONENTS " in
800 *" test_zeroize "*) check_tools "gdb";;
801 esac
802
803 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000804 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000805 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
806 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200807 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000808 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
809 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200810 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
811 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
812 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000813 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000814
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200815 # past this point, no call to check_tool, only printing output
816 if [ $QUIET -eq 1 ]; then
817 return
818 fi
819
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000820 msg "info: output_env.sh"
821 case $RUN_COMPONENTS in
822 *_armcc*)
823 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
824 *) set "$@" RUN_ARMCC=0;;
825 esac
826 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100827}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100828
Gilles Peskine1570b592021-04-22 01:10:12 +0200829pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200830 # since make doesn't have proper dependencies, remove any possibly outdate
831 # file that might be around before generating fresh ones
832 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200833 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200834 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200835 else
836 make generated_files
837 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200838}
839
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000840clang_version() {
841 if command -v clang > /dev/null ; then
842 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
843 else
844 echo 0 # report version 0 for "no clang"
845 fi
846}
847
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200848################################################################
849#### Helpers for components using libtestdriver1
850################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100851
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200852# How to use libtestdriver1
853# -------------------------
854#
855# 1. Define the list algorithms and key types to accelerate,
856# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
857# Examples:
858# - loc_accel_list="ALG_JPAKE"
859# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200860# 2. Make configurations changes for the driver and/or main libraries.
861# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
862# can be either "default" to start with the default config, or a name
863# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200864# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200865# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
866# These changes affect both the driver and the main libraries.
867# (Note: they need to have the same set of PSA_WANT symbols, as that
868# determines the ABI between them.)
869# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
870# main libraries. Typically, you want to disable the module(s) that are
871# being accelerated. You may need to also disable modules that depend
872# on them or options that are not supported with drivers.
873# 2d. On top of psa/crypto_config.h, the driver library uses its own config
874# file: tests/include/test/drivers/config_test_driver.h. You usually
875# don't need to edit it: using loc_extra_list (see below) is preferred.
876# However, when there's no PSA symbol for what you want to enable,
877# calling scripts/config.py on this file remains the only option.
878# 3. Build the driver library, then the main libraries, test, and programs.
879# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
880# need to enable more algorithms here, typically hash algorithms when
881# accelerating some signature algorithms (ECDSA, RSAv2). This is done
882# by passing a 2nd argument listing the extra algorithms.
883# Example:
884# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
885# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800886# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200887# additional arguments will be passed to make: this can be useful if
888# you don't want to build everything when iterating during development.
889# Example:
890# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
891# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200892
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200893# Adjust the configuration - for both libtestdriver1 and main library,
894# as they should have the same PSA_WANT macros.
895helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200896 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200897 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200898 if [ "$base_config" != "default" ]; then
899 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200900 fi
901
902 # Enable PSA-based config (necessary to use drivers)
903 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
904
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200905 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
906 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
907 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000908
909 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
910 # otherwise we will end up running multithreaded tests without mutexes to protect them.
911 if scripts/config.py get MBEDTLS_THREADING_C; then
912 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
913 fi
914
915 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
916 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
917 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200918}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100919
Valerio Settib2fd6732023-08-15 17:10:47 +0200920# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200921# The function optionally accepts 1 parameter: a space-separated list of the
922# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200923helper_disable_builtin_curves() {
924 allowed_list="${1:-}"
925 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
926
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200927 for curve in $allowed_list; do
928 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200929 done
930}
931
932# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
933# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
934# in the following helpers.
935helper_get_psa_curve_list () {
936 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200937 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
938 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200939 done
940
941 echo "$loc_list"
942}
943
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100944# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
945# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
946# in the following helpers.
947helper_get_psa_dh_group_list () {
948 loc_list=""
949 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
950 loc_list="$loc_list $item"
951 done
952
953 echo "$loc_list"
954}
955
Valerio Settib2fd6732023-08-15 17:10:47 +0200956# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200957# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200958# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200959helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200960 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200961 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200962 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 +0200963 # Skip DERIVE for elliptic keys since there is no driver dispatch for
964 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200965 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
966 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200967 fi
968 done
969
970 echo "$loc_list"
971}
972
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200973# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200974#
975# Parameters:
976# 1. a space-separated list of things to accelerate;
977# 2. optional: a space-separate list of things to also support.
978# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
979helper_libtestdriver1_make_drivers() {
980 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100981 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 +0200982}
983
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200984# Build the main libraries, programs and tests,
985# linking to the drivers library (with ASan).
986#
987# Parameters:
988# 1. a space-separated list of things to accelerate;
989# *. remaining arguments if any are passed directly to make
990# (examples: lib, -C tests test_suite_xxx, etc.)
991# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
992helper_libtestdriver1_make_main() {
993 loc_accel_list=$1
994 shift
995
996 # we need flags both with and without the LIBTESTDRIVER1_ prefix
997 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
998 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100999 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 +02001000}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001001
1002################################################################
1003#### Basic checks
1004################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001005
1006#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001007# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001008#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001009# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001010# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001011# 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 +02001012# time, so start with a GCC build).
1013# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001014#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001015# Indicative running times are given for reference.
1016
Gilles Peskine8f073122018-11-27 15:58:47 +01001017component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001018 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001019 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001020}
Janos Follathb72c6782016-07-19 14:54:17 +01001021
Gilles Peskine67debb62021-05-18 16:09:50 +02001022component_check_generated_files () {
1023 msg "Check: check-generated-files, files generated with make" # 2s
1024 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001025 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001026
1027 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001028 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001029 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001030 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001031
1032 msg "Check: check-generated-files -u, files absent" # 2s
1033 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001034 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001035 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001036 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001037
1038 # This component ends with the generated files present in the source tree.
1039 # This is necessary for subsequent components!
1040}
1041
Gilles Peskine8f073122018-11-27 15:58:47 +01001042component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001043 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001044 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001045}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046
Gilles Peskine8f073122018-11-27 15:58:47 +01001047component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001048 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001049 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001050}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001051
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001052component_check_changelog () {
1053 msg "Check: changelog entries" # < 1s
1054 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001055 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001056 if [ -e ChangeLog.new ]; then
1057 # Show the diff for information. It isn't an error if the diff is
1058 # non-empty.
1059 diff -u ChangeLog ChangeLog.new || true
1060 rm ChangeLog.new
1061 fi
1062}
1063
Gilles Peskine8f073122018-11-27 15:58:47 +01001064component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001065 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001066 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001067}
Darryl Greena07039c2018-03-13 16:48:16 +00001068
Gilles Peskine895868b2019-09-19 21:30:05 +02001069component_check_test_cases () {
1070 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001071 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001072 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001073 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001074 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001075 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001076 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001077 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001078}
1079
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001080component_check_test_dependencies () {
1081 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001082 # The purpose of this component is to catch unjustified dependencies on
1083 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1084 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1085 # MBEDTLS_PSA_xxx).
1086 #
1087 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1088 # this component is meant to catch. However a few of them are justified,
1089 # mostly by the absence of a PSA equivalent, so this component includes a
1090 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001091
1092 found="check-test-deps-found-$$"
1093 expected="check-test-deps-expected-$$"
1094
1095 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001096 grep 'depends_on' \
1097 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001098 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001099 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001100 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001101
Yanray Wang18040ed2023-11-23 21:29:56 +08001102 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001103 rm -f $expected
1104 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1105 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001106 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1107 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001108 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1109 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001110 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1111 # the test code and that's probably the most convenient way of achieving
1112 # the test's goal.
1113 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1114 # No PSA equivalent - we should probably have one in the future.
1115 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1116 # No PSA equivalent - needed by some init tests
1117 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001118 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001119 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001120
1121 # Compare reality with expectation.
1122 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001123 #
1124 # The output should be empty. When it's not:
1125 # - Each '+' line is a macro that was found but not expected. You want to
1126 # find where that macro occurs, and either replace it with PSA macros, or
1127 # add it to the exceptions list above with a justification.
1128 # - Each '-' line is a macro that was expected but not found; it means the
1129 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001130 diff -U0 $expected $found
1131
1132 rm $found $expected
1133}
1134
Gilles Peskine8f073122018-11-27 15:58:47 +01001135component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001136 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001137 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001138}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001139
Gilles Peskine192c72f2017-12-21 15:59:21 +01001140
Gilles Peskine636c26a2020-03-04 20:46:15 +01001141
Gilles Peskine192c72f2017-12-21 15:59:21 +01001142################################################################
1143#### Build and test many configurations and targets
1144################################################################
1145
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001146component_test_default_out_of_box () {
1147 msg "build: make, default config (out-of-box)" # ~1min
1148 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001149 # Disable fancy stuff
1150 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001151
1152 msg "test: main suites make, default config (out-of-box)" # ~10s
1153 make test
1154
1155 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001156 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001157
1158 msg "program demos: make, default config (out-of-box)" # ~10s
1159 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001160}
1161
Gilles Peskine8f073122018-11-27 15:58:47 +01001162component_test_default_cmake_gcc_asan () {
1163 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001164 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1165 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001166
Gilles Peskine8f073122018-11-27 15:58:47 +01001167 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1168 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001169
Gilles Peskine82b27272019-06-14 18:27:03 +02001170 msg "program demos (ASan build)" # ~10s
1171 tests/scripts/run_demos.py
1172
Gilles Peskine97bea012020-04-23 23:37:45 +02001173 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001174 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001175
Gilles Peskine6848d172023-11-02 19:58:03 +01001176 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001177 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001178
Gilles Peskine8f073122018-11-27 15:58:47 +01001179 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001180 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001181
Gilles Peskine8f073122018-11-27 15:58:47 +01001182 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001183 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001184
1185 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001186 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001187}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001188
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001189component_test_default_cmake_gcc_asan_new_bignum () {
1190 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001191 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001192 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001193 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001194
1195 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1196 make test
1197
1198 msg "test: selftest (ASan build)" # ~ 10s
1199 programs/test/selftest
1200
1201 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1202 tests/ssl-opt.sh
1203
1204 msg "test: compat.sh (ASan build)" # ~ 6 min
1205 tests/compat.sh
1206
1207 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1208 tests/context-info.sh
1209}
1210
Hanno Becker01635512019-02-26 14:27:09 +00001211component_test_full_cmake_gcc_asan () {
1212 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001213 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001214 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1215 make
1216
1217 msg "test: main suites (inc. selftests) (full config, ASan build)"
1218 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001219
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001220 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001221 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001222
Gilles Peskine636c26a2020-03-04 20:46:15 +01001223 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001224 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001225
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001226 # Note: the next two invocations cover all compat.sh test cases.
1227 # We should use the same here and in basic-build-test.sh.
1228 msg "test: compat.sh: default version (full config, ASan build)"
1229 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnarde7987b62024-04-17 12:30:05 +02001230
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001231 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1232 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001233
1234 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001235 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001236}
1237
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001238
1239component_test_full_cmake_gcc_asan_new_bignum () {
1240 msg "build: full config, cmake, gcc, ASan"
1241 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001242 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001243 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001244 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001245
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001246 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001247 make test
1248
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001249 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001250 programs/test/selftest
1251
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001252 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001253 tests/ssl-opt.sh
1254
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001255 # Note: the next two invocations cover all compat.sh test cases.
1256 # We should use the same here and in basic-build-test.sh.
1257 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1258 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001259
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001260 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1261 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001262
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001263 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001264 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001265}
1266
Ronald Cronc3623db2020-10-29 10:51:32 +01001267component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001268 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001269 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001270 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1271 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1272 make
1273
1274 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1275 make test
1276}
1277
David Horstmann4a48bec2024-03-13 15:42:31 +00001278component_test_psa_assume_exclusive_buffers () {
1279 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001280 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001281 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001282 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1283 make
1284
David Horstmann4a48bec2024-03-13 15:42:31 +00001285 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001286 make test
1287}
1288
Gilles Peskinea3548672021-06-17 11:37:52 +02001289# check_renamed_symbols HEADER LIB
1290# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1291# name is LIB.
1292check_renamed_symbols () {
1293 ! nm "$2" | sed 's/.* //' |
1294 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1295}
1296
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001297component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001298 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001299 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001300 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1301 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1302 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1303 # We can only compile, not link, since our test and sample programs
1304 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1305 # is active.
1306 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001307
1308 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1309 # version is not present.
1310 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001311 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001312}
1313
Valerio Setti63097752024-03-12 13:18:13 +01001314# Get a list of library-wise undefined symbols and ensure that they only
1315# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1316# This function is a common helper used by both:
1317# - component_test_default_psa_crypto_client_without_crypto_provider
1318# - component_build_full_psa_crypto_client_without_crypto_provider.
1319common_check_mbedtls_missing_symbols() {
1320 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1321 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1322 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1323 not grep mbedtls_ linking_errors.txt
1324
1325 rm sym_def.txt sym_undef.txt linking_errors.txt
1326}
1327
1328component_test_default_psa_crypto_client_without_crypto_provider () {
1329 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1330
Ronald Cron336678b2021-01-28 17:54:24 +01001331 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1332 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001333 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001334 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001335 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001336 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001337
Ronald Cron336678b2021-01-28 17:54:24 +01001338 make
1339
Valerio Setti63097752024-03-12 13:18:13 +01001340 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1341 common_check_mbedtls_missing_symbols
1342
1343 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001344 make test
1345}
1346
Valerio Setti63097752024-03-12 13:18:13 +01001347component_build_full_psa_crypto_client_without_crypto_provider () {
1348 msg "build: full config - PSA_CRYPTO_C"
1349
1350 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1351 scripts/config.py full
1352
1353 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1354 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1355 # Dynamic secure element support is a deprecated feature and it is not
1356 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1357 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1358
1359 # Since there is no crypto provider in this build it is not possible to
1360 # build all the test executables and progrems due to missing PSA functions
1361 # at link time. Therefore we will just build libraries and we'll check
1362 # that symbols of interest are there.
1363 make lib
1364
1365 msg "check missing symbols: full config - PSA_CRYPTO_C"
1366
1367 common_check_mbedtls_missing_symbols
1368
1369 # Ensure that desired functions are included into the build (extend the
1370 # following list as required).
1371 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1372 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1373 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1374}
1375
Jaeden Amero424fa932021-05-14 08:34:32 +01001376component_test_psa_crypto_rsa_no_genprime() {
1377 msg "build: default config minus MBEDTLS_GENPRIME"
1378 scripts/config.py unset MBEDTLS_GENPRIME
1379 make
1380
1381 msg "test: default config minus MBEDTLS_GENPRIME"
1382 make test
1383}
1384
Gilles Peskine782f4112018-11-27 16:11:09 +01001385component_test_ref_configs () {
1386 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001387 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1388 # want to re-generate generated files that depend on it, quite correctly.
1389 # However this doesn't work as the generation script expects a specific
1390 # format for mbedtls_config.h, which the other files don't follow. Also,
1391 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001392 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001393 # whether they're on or off. So, disable cmake's (over-sensitive here)
1394 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001395 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001396 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001397 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001398}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001399
Gilles Peskine8f073122018-11-27 15:58:47 +01001400component_test_no_renegotiation () {
1401 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001402 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001403 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001404 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001405
Gilles Peskine8f073122018-11-27 15:58:47 +01001406 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1407 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001408
Gilles Peskine8f073122018-11-27 15:58:47 +01001409 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001410 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001411}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001412
Gilles Peskine636c26a2020-03-04 20:46:15 +01001413component_test_no_pem_no_fs () {
1414 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1415 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1416 scripts/config.py unset MBEDTLS_FS_IO
1417 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1418 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001419 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001420 make
1421
1422 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1423 make test
1424
1425 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001426 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001427}
1428
Gilles Peskine8f073122018-11-27 15:58:47 +01001429component_test_rsa_no_crt () {
1430 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001431 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001432 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001433 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001434
Gilles Peskine8f073122018-11-27 15:58:47 +01001435 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1436 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001437
Gilles Peskine8f073122018-11-27 15:58:47 +01001438 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001439 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001440
Gilles Peskine8f073122018-11-27 15:58:47 +01001441 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001442 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001443
1444 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001445 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001446}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001447
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001448component_test_no_ctr_drbg_classic () {
1449 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001450 scripts/config.py full
1451 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001452 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001453 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001454
Dave Rodgman17127e92023-12-14 16:42:48 +00001455 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001456 make
1457
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001458 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001459 make test
1460
Gilles Peskineba749042021-01-13 20:02:03 +01001461 # In this configuration, the TLS test programs use HMAC_DRBG.
1462 # The SSL tests are slow, so run a small subset, just enough to get
1463 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001464 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001465 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001466
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001467 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001468 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001469}
1470
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001471component_test_no_ctr_drbg_use_psa () {
1472 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001473 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001474 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1475 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001476
Dave Rodgman17127e92023-12-14 16:42:48 +00001477 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001478 make
1479
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001480 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1481 make test
1482
1483 # In this configuration, the TLS test programs use HMAC_DRBG.
1484 # The SSL tests are slow, so run a small subset, just enough to get
1485 # confidence that the SSL code copes with HMAC_DRBG.
1486 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001487 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001488
1489 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001490 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001491}
1492
1493component_test_no_hmac_drbg_classic () {
1494 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1495 scripts/config.py full
1496 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1497 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1498 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001499 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001500
Dave Rodgman17127e92023-12-14 16:42:48 +00001501 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502 make
1503
1504 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001505 make test
1506
Gilles Peskinea2224342020-11-19 22:14:34 +01001507 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1508 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1509 # instead.
1510 # Test SSL with non-deterministic ECDSA. Only test features that
1511 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001513 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001514
1515 # To save time, only test one protocol version, since this part of
1516 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001517 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001518 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001519}
1520
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001521component_test_no_hmac_drbg_use_psa () {
1522 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1523 scripts/config.py full
1524 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1525 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1526 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1527
Dave Rodgman17127e92023-12-14 16:42:48 +00001528 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001529 make
1530
1531 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1532 make test
1533
1534 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1535 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1536 # instead.
1537 # Test SSL with non-deterministic ECDSA. Only test features that
1538 # might be affected by how ECDSA signature is performed.
1539 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001540 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001541
1542 # To save time, only test one protocol version, since this part of
1543 # the protocol is identical in (D)TLS up to 1.2.
1544 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001545 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001546}
1547
1548component_test_psa_external_rng_no_drbg_classic () {
1549 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1550 scripts/config.py full
1551 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001552 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001553 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001554 scripts/config.py unset MBEDTLS_ENTROPY_C
1555 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1556 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001557 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1558 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1559 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001560 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1561 # the SSL test programs don't have an RNG and can't work. Explicitly
1562 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001563 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001564
1565 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1566 make test
1567
Gilles Peskine8eb29432021-02-03 20:07:11 +01001568 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001569 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001570}
1571
1572component_test_psa_external_rng_no_drbg_use_psa () {
1573 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001574 scripts/config.py full
1575 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001576 scripts/config.py unset MBEDTLS_ENTROPY_C
1577 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1578 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001579 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1580 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1581 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001582 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001583
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001585 make test
1586
Gilles Peskine8eb29432021-02-03 20:07:11 +01001587 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001588 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001589}
1590
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001591component_test_psa_external_rng_use_psa_crypto () {
1592 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1593 scripts/config.py full
1594 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1595 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1596 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001597 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001598
1599 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1600 make test
1601
1602 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1603 tests/ssl-opt.sh -f 'Default\|opaque'
1604}
1605
Gilles Peskine801c4332023-04-28 21:04:28 +02001606component_test_psa_inject_entropy () {
1607 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1608 scripts/config.py full
1609 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1610 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1611 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1612 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1613 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1614 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001615 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 +02001616
1617 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1618 make test
1619}
1620
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001621component_test_sw_inet_pton () {
1622 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1623
1624 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1625 scripts/config.py set MBEDTLS_TEST_HOOKS
1626 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1627
1628 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1629 make test
1630}
1631
Valerio Settia41654d2024-02-08 10:33:11 +01001632component_full_no_pkparse_pkwrite() {
1633 msg "build: full without pkparse and pkwrite"
1634
1635 scripts/config.py crypto_full
1636 scripts/config.py unset MBEDTLS_PK_PARSE_C
1637 scripts/config.py unset MBEDTLS_PK_WRITE_C
1638
Valerio Settia41654d2024-02-08 10:33:11 +01001639 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1640
1641 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1642 not grep mbedtls_pk_parse_key library/pkparse.o
1643 not grep mbedtls_pk_write_key_der library/pkwrite.o
1644
1645 msg "test: full without pkparse and pkwrite"
1646 make test
1647}
1648
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001649component_test_crypto_full_md_light_only () {
1650 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001651 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001652 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001653 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001654 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001655 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001656 scripts/config.py unset MBEDTLS_HKDF_C
1657 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001658 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001659 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001660 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001661 # Disable things that would auto-enable MD_C
1662 scripts/config.py unset MBEDTLS_PKCS5_C
1663
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001664 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1665 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001666 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001667
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001668 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001669 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001670 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001671
1672 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001673 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001674}
1675
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001676component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001677 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001678 scripts/config.py full
1679 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001680 # Don't pull in cipher via PSA mechanisms
1681 # (currently ignored anyway because we completely disable PSA)
1682 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001683 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001684 scripts/config.py unset MBEDTLS_CMAC_C
1685 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001686 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001687 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001688 scripts/config.py unset MBEDTLS_SSL_TLS_C
1689 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001690 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001691 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1692 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001693 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001694 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001695 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001696
Valerio Settidf17a102023-10-23 14:14:19 +02001697 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001698 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001699}
1700
Valerio Setti7e710e82023-08-25 09:14:15 +02001701# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001702# - component_test_full_no_cipher_with_psa_crypto
1703# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001704# It accepts 2 input parameters:
1705# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1706# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001707common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001708 USE_CRYPTO_CONFIG="$1"
1709 COMPONENT_DESCRIPTION="$2"
1710
1711 msg "build: $COMPONENT_DESCRIPTION"
1712
1713 scripts/config.py full
1714 scripts/config.py unset MBEDTLS_CIPHER_C
1715
1716 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001717 # The built-in implementation of the following algs/key-types depends
1718 # on CIPHER_C so we disable them.
1719 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1720 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001721 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001722 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1723 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1724 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1725 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1726 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1727 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Cron7d949ae2024-05-15 18:31:17 +02001729 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001730 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001731 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001732 else
1733 # Don't pull in cipher via PSA mechanisms
1734 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001735 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1736 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1737 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001738 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001739 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001740 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001741 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001742
Gilles Peskine21570cf2023-12-22 11:49:50 +01001743 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001744
Valerio Setti7e710e82023-08-25 09:14:15 +02001745 # Ensure that CIPHER_C was not re-enabled
1746 not grep mbedtls_cipher_init library/cipher.o
1747
1748 msg "test: $COMPONENT_DESCRIPTION"
1749 make test
1750}
1751
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001752component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001753 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001754}
1755
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001756component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001757 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001758}
1759
Valerio Settibdfecb62023-11-07 15:37:20 +01001760component_test_full_no_ccm() {
1761 msg "build: full no PSA_WANT_ALG_CCM"
1762
1763 # Full config enables:
1764 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1765 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1766 scripts/config.py full
1767
1768 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1769 # enabled, but not used from TLS since USE_PSA is set.
1770 # This is helpful to ensure that TLS tests below have proper dependencies.
1771 #
1772 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1773 # PSA_WANT_ALG_CCM to be re-enabled.
1774 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1775
Gilles Peskine21570cf2023-12-22 11:49:50 +01001776 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001777
1778 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001779 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001780}
1781
1782component_test_full_no_ccm_star_no_tag() {
1783 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1784
1785 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1786 scripts/config.py full
1787
1788 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1789 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1790 # This basically disables all unauthenticated ciphers on the PSA side, while
1791 # keeping AEADs enabled.
1792 #
1793 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1794 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1795 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1796 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1797 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1798 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1799 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1800 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1801 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1802 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1803
Gilles Peskine21570cf2023-12-22 11:49:50 +01001804 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001805
1806 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001807 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001808
1809 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001810 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001811}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001812
Valerio Settie1655b82023-01-03 15:35:25 +01001813component_test_full_no_bignum () {
1814 msg "build: full minus bignum"
1815 scripts/config.py full
1816 scripts/config.py unset MBEDTLS_BIGNUM_C
1817 # Direct dependencies of bignum
1818 scripts/config.py unset MBEDTLS_ECP_C
1819 scripts/config.py unset MBEDTLS_RSA_C
1820 scripts/config.py unset MBEDTLS_DHM_C
1821 # Direct dependencies of ECP
1822 scripts/config.py unset MBEDTLS_ECDH_C
1823 scripts/config.py unset MBEDTLS_ECDSA_C
1824 scripts/config.py unset MBEDTLS_ECJPAKE_C
1825 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001826 # Disable what auto-enables ECP_LIGHT
1827 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1828 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001829 # Indirect dependencies of ECP
1830 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1831 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1832 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1833 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1834 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1835 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1836 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1837 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1838 # Direct dependencies of DHM
1839 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1840 # Direct dependencies of RSA
1841 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1842 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1843 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1844 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1845 # PK and its dependencies
1846 scripts/config.py unset MBEDTLS_PK_C
1847 scripts/config.py unset MBEDTLS_PK_PARSE_C
1848 scripts/config.py unset MBEDTLS_PK_WRITE_C
1849 scripts/config.py unset MBEDTLS_X509_USE_C
1850 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1851 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1852 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1853 scripts/config.py unset MBEDTLS_X509_CREATE_C
1854 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1855 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1856 scripts/config.py unset MBEDTLS_PKCS7_C
1857 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1858 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1859 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1860
Gilles Peskine21570cf2023-12-22 11:49:50 +01001861 make
Valerio Settie1655b82023-01-03 15:35:25 +01001862
1863 msg "test: full minus bignum"
1864 make test
1865}
1866
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001867component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001868 msg "build: default with only stream cipher"
1869
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001870 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001871 scripts/config.py unset MBEDTLS_GCM_C
1872 scripts/config.py unset MBEDTLS_CCM_C
1873 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001874 #Disable TLS 1.3 (as no AEAD)
1875 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001876 # 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 +02001877 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001878 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001879 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001880 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1881 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001882 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001883 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001884 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001885
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001886 make
1887
1888 msg "test: default with only stream cipher"
1889 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001890
1891 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001892}
1893
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001894component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001895 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001896
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001897 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001898 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001899 scripts/config.py unset MBEDTLS_GCM_C
1900 scripts/config.py unset MBEDTLS_CCM_C
1901 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001902 #Disable TLS 1.3 (as no AEAD)
1903 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001904 # 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 +02001905 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001906 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001907 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001908 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1909 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001910 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001911 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001912 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001913
Przemek Stekiel9550c052022-09-28 09:51:55 +02001914 make
1915
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001916 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001917 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001918
1919 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001920}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001921
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001922component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001923 msg "build: default with only CBC-legacy cipher"
1924
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001925 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001926 scripts/config.py unset MBEDTLS_GCM_C
1927 scripts/config.py unset MBEDTLS_CCM_C
1928 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001929 #Disable TLS 1.3 (as no AEAD)
1930 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001931 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1932 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1933 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001934 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001935 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001936 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001937 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001938 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001939 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001940
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001941 make
1942
1943 msg "test: default with only CBC-legacy cipher"
1944 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001945
1946 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1947 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001948}
1949
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001950component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001951 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001952
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001953 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001954 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001955 scripts/config.py unset MBEDTLS_GCM_C
1956 scripts/config.py unset MBEDTLS_CCM_C
1957 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001958 #Disable TLS 1.3 (as no AEAD)
1959 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001960 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1961 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1962 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001963 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001964 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001965 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001966 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001967 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001968 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001969
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001970 make
1971
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001972 msg "test: default with only CBC-legacy cipher use psa"
1973 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001974
1975 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1976 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001977}
1978
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001979component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001980 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1981
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001982 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001983 scripts/config.py unset MBEDTLS_GCM_C
1984 scripts/config.py unset MBEDTLS_CCM_C
1985 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001986 #Disable TLS 1.3 (as no AEAD)
1987 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001988 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1989 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1990 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1991 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1992 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001993 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001994 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001995 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001996 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001997
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001998 make
1999
2000 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2001 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002002
2003 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2004 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002005}
2006
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002007component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2008 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002009
2010 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002011 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002012 scripts/config.py unset MBEDTLS_GCM_C
2013 scripts/config.py unset MBEDTLS_CCM_C
2014 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002015 #Disable TLS 1.3 (as no AEAD)
2016 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002017 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2018 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2019 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2020 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2021 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002022 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002023 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002024 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002025 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002026
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002027 make
2028
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002029 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002030 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002031
2032 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2033 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002034}
2035
Valerio Setti9f0ec532022-11-08 13:03:24 +01002036# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2037# that we could use for interop testing. However, we now have sort of two
2038# implementations ourselves: one using PSA, the other not. At least test that
2039# these two interoperate with each other.
2040component_test_tls1_2_ecjpake_compatibility() {
2041 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2042 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002043 # Explicitly make lib first to avoid a race condition:
2044 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2045 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002046 make -C programs ssl/ssl_server2 ssl/ssl_client2
2047 cp programs/ssl/ssl_server2 s2_no_use_psa
2048 cp programs/ssl/ssl_client2 c2_no_use_psa
2049
2050 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2051 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2052 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002053 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002054 make -C programs ssl/ssl_server2 ssl/ssl_client2
2055 make -C programs test/udp_proxy test/query_compile_time_config
2056
Valerio Setti70e02902022-12-02 16:21:56 +01002057 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2058 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2059 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2060 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2061 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2062 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2063 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2064 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 +01002065
2066 rm s2_no_use_psa c2_no_use_psa
2067}
2068
Gilles Peskine636c26a2020-03-04 20:46:15 +01002069component_test_everest () {
2070 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2071 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2072 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2073 make
2074
2075 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2076 make test
2077
Gilles Peskine6848d172023-11-02 19:58:03 +01002078 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002079 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002080
Gilles Peskine636c26a2020-03-04 20:46:15 +01002081 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2082 tests/ssl-opt.sh -f ECDH
2083
2084 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2085 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002086 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002087}
2088
Gilles Peskined3beca92020-07-03 00:15:37 +02002089component_test_everest_curve25519_only () {
2090 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002091 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2092 scripts/config.py unset MBEDTLS_ECDSA_C
2093 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2094 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002095 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002096 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002097 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002098 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2099
Dave Rodgman17127e92023-12-14 16:42:48 +00002100 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002101
2102 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2103 make test
2104}
2105
Gilles Peskine8f073122018-11-27 15:58:47 +01002106component_test_small_ssl_out_content_len () {
2107 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002108 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2109 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002110 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002111 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002112
Gilles Peskine8f073122018-11-27 15:58:47 +01002113 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002114 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002115}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002116
Gilles Peskine8f073122018-11-27 15:58:47 +01002117component_test_small_ssl_in_content_len () {
2118 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002119 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2120 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002121 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002122 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002123
Gilles Peskine8f073122018-11-27 15:58:47 +01002124 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002125 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002126}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002127
Gilles Peskine8f073122018-11-27 15:58:47 +01002128component_test_small_ssl_dtls_max_buffering () {
2129 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002130 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002131 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002132 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002133
Gilles Peskine8f073122018-11-27 15:58:47 +01002134 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002135 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 +01002136}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002137
Gilles Peskine8f073122018-11-27 15:58:47 +01002138component_test_small_mbedtls_ssl_dtls_max_buffering () {
2139 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002140 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002141 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002142 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002143
Gilles Peskine8f073122018-11-27 15:58:47 +01002144 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002145 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002146}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002147
Gilles Peskine75cc7712019-09-06 19:47:17 +02002148component_test_psa_collect_statuses () {
2149 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002150 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002151 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002152 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002153 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002154 rm -f tests/statuses.log
2155}
2156
Gilles Peskine8f073122018-11-27 15:58:47 +01002157component_test_full_cmake_clang () {
2158 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002159 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002160 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 +01002161 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002162
k-stachowiak0291cb72019-06-26 15:52:12 +02002163 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002164 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002165
Gilles Peskineda6017c2022-10-30 21:02:40 +01002166 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2167 programs/test/cpp_dummy_build
2168
Gilles Peskine6848d172023-11-02 19:58:03 +01002169 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002170 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002171
Gilles Peskine82b27272019-06-14 18:27:03 +02002172 msg "program demos (full config, clang)" # ~10s
2173 tests/scripts/run_demos.py
2174
k-stachowiak0291cb72019-06-26 15:52:12 +02002175 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002176 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002177
Gilles Peskine8f073122018-11-27 15:58:47 +01002178 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002179 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002180}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002181
Gilles Peskine0c671602022-11-29 16:01:41 +01002182skip_suites_without_constant_flow () {
2183 # Skip the test suites that don't have any constant-flow annotations.
2184 # This will need to be adjusted if we ever start declaring things as
2185 # secret from macros or functions inside tests/include or tests/src.
2186 SKIP_TEST_SUITES=$(
2187 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2188 sed 's/test_suite_//; s/\.function$//' |
2189 tr '\n' ,)
2190 export SKIP_TEST_SUITES
2191}
2192
Dave Rodgman246210e2023-07-31 18:07:44 +01002193skip_all_except_given_suite () {
2194 # Skip all but the given test suite
2195 SKIP_TEST_SUITES=$(
2196 ls -1 tests/suites/test_suite_*.function |
2197 grep -v $1.function |
2198 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2199 tr '\n' ,)
2200 export SKIP_TEST_SUITES
2201}
2202
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002203component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002204 # This tests both (1) accesses to undefined memory, and (2) branches or
2205 # memory access depending on secret values. To distinguish between those:
2206 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2207 # - or alternatively, change the build type to MemSanDbg, which enables
2208 # origin tracking and nicer stack traces (which are useful for debugging
2209 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002210 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2211 scripts/config.py full
2212 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2213 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2214 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2215 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2216 make
2217
2218 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2219 make test
2220}
2221
2222component_test_memsan_constant_flow_psa () {
2223 # This tests both (1) accesses to undefined memory, and (2) branches or
2224 # memory access depending on secret values. To distinguish between those:
2225 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2226 # - or alternatively, change the build type to MemSanDbg, which enables
2227 # origin tracking and nicer stack traces (which are useful for debugging
2228 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002229 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002230 scripts/config.py full
2231 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2232 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2233 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2234 make
2235
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002236 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002237 make test
2238}
2239
Bence Szépkúti0354d042023-12-06 16:14:37 +01002240component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002241 # This tests both (1) everything that valgrind's memcheck usually checks
2242 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2243 # etc.) and (2) branches or memory access depending on secret values,
2244 # which will be reported as uninitialized memory. To distinguish between
2245 # secret and actually uninitialized:
2246 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2247 # - or alternatively, build with debug info and manually run the offending
2248 # test suite with valgrind --track-origins=yes, then check if the origin
2249 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002250 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2251 scripts/config.py full
2252 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2253 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002254 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002255 cmake -D CMAKE_BUILD_TYPE:String=Release .
2256 make
2257
2258 # this only shows a summary of the results (how many of each type)
2259 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002260 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002261 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002262
2263 # Test asm path in constant time module - by default, it will test the plain C
2264 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2265 msg "test: valgrind asm constant_time"
2266 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2267 skip_all_except_given_suite test_suite_constant_time
2268 cmake -D CMAKE_BUILD_TYPE:String=Release .
2269 make clean
2270 make
2271 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002272}
2273
Bence Szépkúti0354d042023-12-06 16:14:37 +01002274component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002275 # This tests both (1) everything that valgrind's memcheck usually checks
2276 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2277 # etc.) and (2) branches or memory access depending on secret values,
2278 # which will be reported as uninitialized memory. To distinguish between
2279 # secret and actually uninitialized:
2280 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2281 # - or alternatively, build with debug info and manually run the offending
2282 # test suite with valgrind --track-origins=yes, then check if the origin
2283 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002284 msg "build: cmake release GCC, full config with constant flow testing"
2285 scripts/config.py full
2286 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002287 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002288 cmake -D CMAKE_BUILD_TYPE:String=Release .
2289 make
2290
2291 # this only shows a summary of the results (how many of each type)
2292 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002293 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002294 make memcheck
2295}
2296
Janos Follath9338cac2023-10-04 18:55:39 +01002297component_test_tsan () {
2298 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002299 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002300 scripts/config.py set MBEDTLS_THREADING_C
2301 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002302 # Self-tests do not currently use multiple threads.
2303 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002304
Ryan6caf84f2024-03-05 13:57:00 +00002305 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2306 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2307
Janos Follath9338cac2023-10-04 18:55:39 +01002308 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2309 make
2310
2311 msg "test: main suites (TSan)"
2312 make test
2313}
2314
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002315component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002316 # Test that removing the deprecated features from the default
2317 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002318 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2319 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002320 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002321
2322 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2323 make test
2324}
2325
2326component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002327 msg "build: make, full_no_deprecated config" # ~ 30s
2328 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002329 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002330
Gilles Peskine30de2e82020-04-20 21:39:22 +02002331 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002332 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002333
2334 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2335 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002336}
2337
Gilles Peskine8386ea22020-04-30 09:07:29 +02002338component_test_full_no_deprecated_deprecated_warning () {
2339 # Test that there is nothing deprecated in "full_no_deprecated".
2340 # A deprecated feature would trigger a warning (made fatal) from
2341 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002342 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2343 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002344 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2345 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002346 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002347
Gilles Peskine30de2e82020-04-20 21:39:22 +02002348 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002349 make test
2350}
2351
Gilles Peskine8386ea22020-04-30 09:07:29 +02002352component_test_full_deprecated_warning () {
2353 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2354 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002355 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002356 scripts/config.py full
2357 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002358 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002359 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2360 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002361 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002362
Gilles Peskine8386ea22020-04-30 09:07:29 +02002363 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2364 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2365 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002366 # Expect warnings from '#warning' directives in check_config.h and
2367 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002368 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 +01002369
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002370 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2371 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002372
2373 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2374 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002375}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002376
Gilles Peskineec541fe2020-01-31 14:24:14 +01002377# Check that the specified libraries exist and are empty.
2378are_empty_libraries () {
2379 nm "$@" >/dev/null 2>/dev/null
2380 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2381}
2382
2383component_build_crypto_default () {
2384 msg "build: make, crypto only"
2385 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002386 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002387 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002388}
2389
2390component_build_crypto_full () {
2391 msg "build: make, crypto only, full config"
2392 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002393 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002394 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002395}
2396
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002397component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002398 msg "build: make, config for PSA crypto service"
2399 scripts/config.py crypto
2400 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2401 # Disable things that are not needed for just cryptography, to
2402 # reach a configuration that would be typical for a PSA cryptography
2403 # service providing all implemented PSA algorithms.
2404 # System stuff
2405 scripts/config.py unset MBEDTLS_ERROR_C
2406 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002407 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002408 # Crypto stuff with no PSA interface
2409 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002410 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002411 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002412 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002413 scripts/config.py unset MBEDTLS_NIST_KW_C
2414 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2415 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2416 scripts/config.py unset MBEDTLS_PKCS12_C
2417 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002418 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2419 # in PSA code to work with RSA keys. We don't require users to set those:
2420 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002421 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002422 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002423 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002424 make CFLAGS='-O1 -Werror' all test
2425 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2426}
2427
Gilles Peskineec541fe2020-01-31 14:24:14 +01002428component_build_crypto_baremetal () {
2429 msg "build: make, crypto only, baremetal config"
2430 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002431 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002432 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002433}
Daniel Axtens446af202020-09-02 21:30:13 +10002434support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002435 support_build_baremetal "$@"
2436}
2437
2438component_build_baremetal () {
2439 msg "build: make, baremetal config"
2440 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002441 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002442}
2443support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002444 # Older Glibc versions include time.h from other headers such as stdlib.h,
2445 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2446 # problem, Ubuntu 18.04 is ok.
2447 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2448}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002449
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002450# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002451component_test_depends_py_cipher_id () {
2452 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002453 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002454}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002455
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002456component_test_depends_py_cipher_chaining () {
2457 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002458 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002459}
2460
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002461component_test_depends_py_cipher_padding () {
2462 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002463 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002464}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002465
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002466component_test_depends_py_curves () {
2467 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002468 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002469}
2470
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002471component_test_depends_py_hashes () {
2472 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002473 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002474}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002475
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002476component_test_depends_py_kex () {
2477 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002478 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002479}
2480
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002481component_test_depends_py_pkalgs () {
2482 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002483 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002484}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002485
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002486# PSA equivalents of the depends.py tests
2487component_test_depends_py_cipher_id_psa () {
2488 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002489 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002490}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002491
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002492component_test_depends_py_cipher_chaining_psa () {
2493 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002494 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002495}
2496
2497component_test_depends_py_cipher_padding_psa () {
2498 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002499 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002500}
2501
2502component_test_depends_py_curves_psa () {
2503 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002504 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002505}
2506
2507component_test_depends_py_hashes_psa () {
2508 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002509 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002510}
2511
2512component_test_depends_py_kex_psa () {
2513 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002514 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002515}
2516
2517component_test_depends_py_pkalgs_psa () {
2518 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002519 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002520}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002521
Valerio Setti6bed64e2024-01-17 15:21:44 +01002522component_test_psa_crypto_config_ffdh_2048_only () {
2523 msg "build: full config - only DH 2048"
2524
2525 scripts/config.py full
2526
2527 # Disable all DH groups other than 2048.
2528 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2529 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2530 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2531 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2532
2533 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2534
2535 msg "test: full config - only DH 2048"
2536 make test
2537
2538 msg "ssl-opt: full config - only DH 2048"
2539 tests/ssl-opt.sh -f "ffdh"
2540}
2541
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002542component_build_no_pk_rsa_alt_support () {
2543 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2544
2545 scripts/config.py full
2546 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2547 scripts/config.py set MBEDTLS_RSA_C
2548 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2549
2550 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002551 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002552}
2553
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002554component_build_module_alt () {
2555 msg "build: MBEDTLS_XXX_ALT" # ~30s
2556 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002557
2558 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002559 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2560 scripts/config.py unset MBEDTLS_AESNI_C
2561 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002562 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002563 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2564 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002565 # You can only have one threading implementation: alt or pthread, not both.
2566 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002567 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2568 # directly and assumes the implementation works with partial groups.
2569 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002570 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2571 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2572 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002573 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2574 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2575 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002576
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002577 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2578 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2579 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002580 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002581
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002582 # We can only compile, not link, since we don't have any implementations
2583 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002584 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002585}
2586
2587component_build_dhm_alt () {
2588 msg "build: MBEDTLS_DHM_ALT" # ~30s
2589 scripts/config.py full
2590 scripts/config.py set MBEDTLS_DHM_ALT
2591 # debug.c currently references mbedtls_dhm_context fields directly.
2592 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002593 # We can only compile, not link, since we don't have any implementations
2594 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002595 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002596}
2597
Gilles Peskine64996c32024-01-23 20:25:47 +01002598component_test_no_psa_crypto_full_cmake_asan() {
2599 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2600 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002601 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002602 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002603 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002604 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002605 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002606 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002607 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002608 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002609 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002610 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002611 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002612 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002613
Gilles Peskine64996c32024-01-23 20:25:47 +01002614 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002615 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002616
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002617 # Note: ssl-opt.sh has some test cases that depend on
2618 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2619 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002620 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002621 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002622
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02002623 # Note: the next two invocations cover all compat.sh test cases.
2624 # We should use the same here and in basic-build-test.sh.
2625 msg "test: compat.sh: default version (full minus PSA crypto)"
2626 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002627
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02002628 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002629 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002630}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002631
Ronald Cron403c15c2021-09-13 09:38:05 +02002632component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002633 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002634
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002635 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002636 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002637 $(helper_get_psa_key_type_list "ECC") \
2638 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002639
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002640 # Configure
2641 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002642
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002643 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002644 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002645
2646 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002647 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002648
2649 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002650 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2651 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2652
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002653 # Build
2654 # -----
2655
2656 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002657 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2658 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002659
2660 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2661
Valerio Setti3fe105b2023-10-30 11:08:12 +01002662 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002663
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002664 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002665 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002666
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002667 # Run the tests
2668 # -------------
2669
Ronald Cron403c15c2021-09-13 09:38:05 +02002670 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2671 make test
2672}
2673
Valerio Setti44b178c2023-03-22 14:02:57 +01002674component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002675 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002676
2677 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002678 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002679 $(helper_get_psa_key_type_list "ECC") \
2680 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002681
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002682 # Configure
2683 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002684
Ronald Cron46ac0652024-03-18 12:39:04 +01002685 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002686 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002687
Valerio Setti44b178c2023-03-22 14:02:57 +01002688 # Disable the module that's accelerated
2689 scripts/config.py unset MBEDTLS_ECDH_C
2690
2691 # Disable things that depend on it
2692 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2693 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2694 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2695 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2696 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2697
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002698 # Build
2699 # -----
2700
2701 helper_libtestdriver1_make_drivers "$loc_accel_list"
2702
Valerio Setti3fe105b2023-10-30 11:08:12 +01002703 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002704
Valerio Setti44b178c2023-03-22 14:02:57 +01002705 # Make sure this was not re-enabled by accident (additive config)
2706 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002707
2708 # Run the tests
2709 # -------------
2710
Valerio Setti44b178c2023-03-22 14:02:57 +01002711 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002712 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002713}
2714
Przemek Stekieldccb2022023-05-11 10:48:50 +02002715component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002716 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002717
2718 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002719 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002720 $(helper_get_psa_key_type_list "DH") \
2721 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002722
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002723 # Configure
2724 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002725
Przemek Stekiel565353e2023-07-05 11:07:07 +02002726 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002727 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002728
2729 # Disable the module that's accelerated
2730 scripts/config.py unset MBEDTLS_DHM_C
2731
2732 # Disable things that depend on it
2733 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2734 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2735
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002736 # Build
2737 # -----
2738
2739 helper_libtestdriver1_make_drivers "$loc_accel_list"
2740
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002741 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002742
2743 # Make sure this was not re-enabled by accident (additive config)
2744 not grep mbedtls_dhm_ library/dhm.o
2745
2746 # Run the tests
2747 # -------------
2748
Gilles Peskine14302ed2023-07-19 19:30:04 +02002749 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002750 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002751
Gilles Peskine14302ed2023-07-19 19:30:04 +02002752 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002753 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002754}
2755
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002756component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002757 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002758
2759 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002760 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002761
2762 # Disable things that are not supported
2763 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2764 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002765 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002766
Gilles Peskine14302ed2023-07-19 19:30:04 +02002767 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002768 make test
2769
Gilles Peskine14302ed2023-07-19 19:30:04 +02002770 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002771 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002772}
2773
Valerio Setti44b178c2023-03-22 14:02:57 +01002774component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002775 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002776
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002777 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002778 $(helper_get_psa_key_type_list "ECC") \
2779 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002780
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002781 # Configure
2782 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002783
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002784 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002785
2786 # Make built-in fallback not available
2787 scripts/config.py unset MBEDTLS_ECJPAKE_C
2788 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2789
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002790 # Build
2791 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002792
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002793 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002794
Valerio Setti3fe105b2023-10-30 11:08:12 +01002795 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002796
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002797 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002798 not grep mbedtls_ecjpake_init library/ecjpake.o
2799
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002800 # Run the tests
2801 # -------------
2802
Gilles Peskine14302ed2023-07-19 19:30:04 +02002803 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002804 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002805}
2806
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002807component_test_psa_crypto_config_accel_ecc_some_key_types () {
2808 msg "build: full with accelerated EC algs and some key types"
2809
2810 # Algorithms and key types to accelerate
2811 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2812 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2813 ALG_ECDH \
2814 ALG_JPAKE \
2815 KEY_TYPE_ECC_PUBLIC_KEY \
2816 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2817 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002818 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2819 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002820
2821 # Configure
2822 # ---------
2823
2824 # start with config full for maximum coverage (also enables USE_PSA)
2825 helper_libtestdriver1_adjust_config "full"
2826
2827 # Disable modules that are accelerated - some will be re-enabled
2828 scripts/config.py unset MBEDTLS_ECDSA_C
2829 scripts/config.py unset MBEDTLS_ECDH_C
2830 scripts/config.py unset MBEDTLS_ECJPAKE_C
2831 scripts/config.py unset MBEDTLS_ECP_C
2832
2833 # Disable all curves - those that aren't accelerated should be re-enabled
2834 helper_disable_builtin_curves
2835
2836 # Restartable feature is not yet supported by PSA. Once it will in
2837 # the future, the following line could be removed (see issues
2838 # 6061, 6332 and following ones)
2839 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2840
2841 # this is not supported by the driver API yet
2842 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2843
2844 # Build
2845 # -----
2846
2847 # These hashes are needed for some ECDSA signature tests.
2848 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2849 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2850 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2851
Valerio Setti3fe105b2023-10-30 11:08:12 +01002852 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002853
2854 # ECP should be re-enabled but not the others
2855 not grep mbedtls_ecdh_ library/ecdh.o
2856 not grep mbedtls_ecdsa library/ecdsa.o
2857 not grep mbedtls_ecjpake library/ecjpake.o
2858 grep mbedtls_ecp library/ecp.o
2859
2860 # Run the tests
2861 # -------------
2862
2863 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002864 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002865}
2866
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002867# Run tests with only (non-)Weierstrass accelerated
2868# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002869# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2870# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002871common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002872 weierstrass=$1
2873 if [ $weierstrass -eq 1 ]; then
2874 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002875 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002876 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002877 fi
2878
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002879 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002880
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002881 # Note: Curves are handled in a special way by the libtestdriver machinery,
2882 # so we only want to include them in the accel list when building the main
2883 # libraries, hence the use of a separate variable.
2884 # Note: the following loop is a modified version of
2885 # helper_get_psa_curve_list that only keeps Weierstrass families.
2886 loc_weierstrass_list=""
2887 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002888 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2889 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002890 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002891 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002892 ;;
2893 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002894 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002895 ;;
2896 esac
2897 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002898 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002899 loc_curve_list=$loc_weierstrass_list
2900 else
2901 loc_curve_list=$loc_non_weierstrass_list
2902 fi
2903
Valerio Setti3fe105b2023-10-30 11:08:12 +01002904 # Algorithms and key types to accelerate
2905 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2906 ALG_ECDH \
2907 ALG_JPAKE \
2908 $(helper_get_psa_key_type_list "ECC") \
2909 $loc_curve_list"
2910
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002911 # Configure
2912 # ---------
2913
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002914 # Start with config crypto_full and remove PK_C:
2915 # that's what's supported now, see docs/driver-only-builds.md.
2916 helper_libtestdriver1_adjust_config "crypto_full"
2917 scripts/config.py unset MBEDTLS_PK_C
2918 scripts/config.py unset MBEDTLS_PK_PARSE_C
2919 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002920
2921 # Disable modules that are accelerated - some will be re-enabled
2922 scripts/config.py unset MBEDTLS_ECDSA_C
2923 scripts/config.py unset MBEDTLS_ECDH_C
2924 scripts/config.py unset MBEDTLS_ECJPAKE_C
2925 scripts/config.py unset MBEDTLS_ECP_C
2926
2927 # Disable all curves - those that aren't accelerated should be re-enabled
2928 helper_disable_builtin_curves
2929
2930 # Restartable feature is not yet supported by PSA. Once it will in
2931 # the future, the following line could be removed (see issues
2932 # 6061, 6332 and following ones)
2933 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2934
2935 # this is not supported by the driver API yet
2936 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2937
2938 # Build
2939 # -----
2940
2941 # These hashes are needed for some ECDSA signature tests.
2942 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2943 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2944 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2945
Valerio Settiac7a8092023-10-31 12:23:44 +01002946 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002947
2948 # We expect ECDH to be re-enabled for the missing curves
2949 grep mbedtls_ecdh_ library/ecdh.o
2950 # We expect ECP to be re-enabled, however the parts specific to the
2951 # families of curves that are accelerated should be ommited.
2952 # - functions with mxz in the name are specific to Montgomery curves
2953 # - ecp_muladd is specific to Weierstrass curves
2954 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002955 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002956 not grep mbedtls_ecp_muladd library/ecp.o
2957 grep mxz library/ecp.o
2958 else
2959 grep mbedtls_ecp_muladd library/ecp.o
2960 not grep mxz library/ecp.o
2961 fi
2962 # We expect ECDSA and ECJPAKE to be re-enabled only when
2963 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002964 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002965 not grep mbedtls_ecdsa library/ecdsa.o
2966 not grep mbedtls_ecjpake library/ecjpake.o
2967 else
2968 grep mbedtls_ecdsa library/ecdsa.o
2969 grep mbedtls_ecjpake library/ecjpake.o
2970 fi
2971
2972 # Run the tests
2973 # -------------
2974
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002975 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2976 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002977}
2978
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002979component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002980 common_test_psa_crypto_config_accel_ecc_some_curves 1
2981}
2982
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002983component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002984 common_test_psa_crypto_config_accel_ecc_some_curves 0
2985}
2986
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002987# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2988# ECDH, ECDSA) with and without drivers.
2989# The input parameter is a boolean value which indicates:
2990# - 0 keep built-in EC algs,
2991# - 1 exclude built-in EC algs (driver only).
2992#
2993# This is used by the two following components to ensure they always use the
2994# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002995# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2996# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002997# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002998config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002999 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01003000 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003001 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003002 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003003 # Disable modules that are accelerated
3004 scripts/config.py unset MBEDTLS_ECDSA_C
3005 scripts/config.py unset MBEDTLS_ECDH_C
3006 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003007 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003008 fi
3009
3010 # Restartable feature is not yet supported by PSA. Once it will in
3011 # the future, the following line could be removed (see issues
3012 # 6061, 6332 and following ones)
3013 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003014}
3015
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003016# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3017component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003018 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003019
3020 # Algorithms and key types to accelerate
3021 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3022 ALG_ECDH \
3023 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003024 $(helper_get_psa_key_type_list "ECC") \
3025 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003026
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003027 # Configure
3028 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003029
3030 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003031 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003032
Valerio Setti0a342c92023-09-01 09:12:31 +02003033 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003034 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3035 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003036
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003037 # Build
3038 # -----
3039
3040 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003041 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3042 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003043 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3044
Valerio Setti3fe105b2023-10-30 11:08:12 +01003045 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003046
3047 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3048 not grep mbedtls_ecdsa_ library/ecdsa.o
3049 not grep mbedtls_ecdh_ library/ecdh.o
3050 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003051 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003052
3053 # Run the tests
3054 # -------------
3055
Gilles Peskine14302ed2023-07-19 19:30:04 +02003056 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003057 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003058
Gilles Peskine14302ed2023-07-19 19:30:04 +02003059 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003060 tests/ssl-opt.sh
3061}
3062
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003063# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3064component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003065 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003066
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003067 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003068
Gilles Peskine21570cf2023-12-22 11:49:50 +01003069 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003070
Gilles Peskine14302ed2023-07-19 19:30:04 +02003071 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003072 make test
3073
Gilles Peskine14302ed2023-07-19 19:30:04 +02003074 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003075 tests/ssl-opt.sh
3076}
3077
Valerio Settie618cb02023-04-12 14:59:16 +02003078# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003079# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3080# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003081# to ensure that both tests use the same underlying configuration when testing
3082# driver's coverage with analyze_outcomes.py.
3083#
3084# This functions accepts 1 boolean parameter as follows:
3085# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3086# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3087# - 0: include built-in implementation of EC algorithms.
3088#
3089# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3090# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003091config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003092 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003093 # start with full config for maximum coverage (also enables USE_PSA)
3094 helper_libtestdriver1_adjust_config "full"
3095
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003096 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003097 # Disable modules that are accelerated
3098 scripts/config.py unset MBEDTLS_ECDSA_C
3099 scripts/config.py unset MBEDTLS_ECDH_C
3100 scripts/config.py unset MBEDTLS_ECJPAKE_C
3101 # Disable ECP module (entirely)
3102 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003103 fi
3104
Valerio Settiaecd32c2023-06-14 10:42:31 +02003105 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3106 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003107 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003108 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003109
Valerio Settie618cb02023-04-12 14:59:16 +02003110 # Restartable feature is not yet supported by PSA. Once it will in
3111 # the future, the following line could be removed (see issues
3112 # 6061, 6332 and following ones)
3113 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003114}
3115
3116# Build and test a configuration where driver accelerates all EC algs while
3117# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3118# side.
3119#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003120# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3121component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003122 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003123
3124 # Algorithms and key types to accelerate
3125 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3126 ALG_ECDH \
3127 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003128 $(helper_get_psa_key_type_list "ECC") \
3129 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003130
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003131 # Configure
3132 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003133
Valerio Settie618cb02023-04-12 14:59:16 +02003134 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003135 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003136 # Disable all the builtin curves. All the required algs are accelerated.
3137 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003138
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003139 # Build
3140 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003141
3142 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003143 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3144 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3145 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003146
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003147 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003148
Valerio Setti3fe105b2023-10-30 11:08:12 +01003149 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003150
3151 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3152 not grep mbedtls_ecdsa_ library/ecdsa.o
3153 not grep mbedtls_ecdh_ library/ecdh.o
3154 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003155 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003156 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003157
3158 # Run the tests
3159 # -------------
3160
Gilles Peskine14302ed2023-07-19 19:30:04 +02003161 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003162 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003163
Gilles Peskine14302ed2023-07-19 19:30:04 +02003164 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003165 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003166}
3167
3168# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003169# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003170# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003171component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003172 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003173
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003174 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003175
Gilles Peskine21570cf2023-12-22 11:49:50 +01003176 make
Valerio Settie618cb02023-04-12 14:59:16 +02003177
Gilles Peskine14302ed2023-07-19 19:30:04 +02003178 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003179 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003180
Gilles Peskine14302ed2023-07-19 19:30:04 +02003181 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003182 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003183}
3184
Valerio Setti4e2f2442023-08-15 10:10:26 +02003185# This is a common configuration helper used directly from:
3186# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3187# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3188# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003189# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003190# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003191# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003192# - this is the reference component of the above
3193# - it still disables RSA and FFDH, but it uses builtin EC algs
3194# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3195# - accelerate all EC and FFDH algs, disable only RSA
3196# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3197# - this is the reference component of the above
3198# - it still disables RSA, but it uses builtin EC and FFDH algs
3199#
3200# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003201# $1: a boolean value which states if we are testing an accelerated scenario
3202# or not.
3203# $2: a string value which states which components are tested. Allowed values
3204# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003205config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003206 driver_only="$1"
3207 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003208 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003209 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003210
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003211 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003212 # Disable modules that are accelerated
3213 scripts/config.py unset MBEDTLS_ECDSA_C
3214 scripts/config.py unset MBEDTLS_ECDH_C
3215 scripts/config.py unset MBEDTLS_ECJPAKE_C
3216 # Disable ECP module (entirely)
3217 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003218 # Also disable bignum
3219 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003220 fi
3221
3222 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3223 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3224 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3225 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3226
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003227 # RSA support is intentionally disabled on this test because RSA_C depends
3228 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003229 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3230 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 +02003231 scripts/config.py unset MBEDTLS_RSA_C
3232 scripts/config.py unset MBEDTLS_PKCS1_V15
3233 scripts/config.py unset MBEDTLS_PKCS1_V21
3234 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3235 # Also disable key exchanges that depend on RSA
3236 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3237 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3238 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3239 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3240 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3241
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003242 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003243 # When testing ECC only, we disable FFDH support, both from builtin and
3244 # PSA sides, and also disable the key exchanges that depend on DHM.
3245 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3246 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 +01003247 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003248 scripts/config.py unset MBEDTLS_DHM_C
3249 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3250 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3251 else
3252 # When testing ECC and DH instead, we disable DHM and depending key
3253 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003254 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003255 scripts/config.py unset MBEDTLS_DHM_C
3256 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3257 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3258 fi
3259 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003260
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003261 # Restartable feature is not yet supported by PSA. Once it will in
3262 # the future, the following line could be removed (see issues
3263 # 6061, 6332 and following ones)
3264 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3265}
3266
Valerio Setti4e2f2442023-08-15 10:10:26 +02003267# Common helper used by:
3268# - component_test_psa_crypto_config_accel_ecc_no_bignum
3269# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003270#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003271# The goal is to build and test accelerating either:
3272# - ECC only or
3273# - both ECC and FFDH
3274#
3275# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003276# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3277# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003278common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003279 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003280
Valerio Setti5dfaca42023-09-05 08:48:51 +02003281 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003282 if [ "$test_target" = "ECC_DH" ]; then
3283 accel_text="ECC/FFDH"
3284 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003285 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003286 accel_text="ECC"
3287 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003288 fi
3289
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003290 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003291
3292 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003293 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3294 ALG_ECDH \
3295 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003296 $(helper_get_psa_key_type_list "ECC") \
3297 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003298 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003299 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003300 loc_accel_list="$loc_accel_list \
3301 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003302 $(helper_get_psa_key_type_list "DH") \
3303 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003304 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003305
3306 # Configure
3307 # ---------
3308
3309 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003310 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003311 # Disable all the builtin curves. All the required algs are accelerated.
3312 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003313
3314 # Build
3315 # -----
3316
3317 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003318 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3319 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3320 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003321
3322 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3323
Valerio Setti3fe105b2023-10-30 11:08:12 +01003324 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003325
3326 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3327 not grep mbedtls_ecdsa_ library/ecdsa.o
3328 not grep mbedtls_ecdh_ library/ecdh.o
3329 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003330 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003331 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003332 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003333 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003334 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003335
3336 # Run the tests
3337 # -------------
3338
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003339 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003340
Gilles Peskine21570cf2023-12-22 11:49:50 +01003341 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003342
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003343 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003344 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003345}
3346
Valerio Setti4e2f2442023-08-15 10:10:26 +02003347# Common helper used by:
3348# - component_test_psa_crypto_config_reference_ecc_no_bignum
3349# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3350#
3351# The goal is to build and test a reference scenario (i.e. with builtin
3352# components) compared to the ones used in
3353# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3354#
3355# It is meant to be used in conjunction with
3356# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3357# coverage analysis in "analyze_outcomes.py" script.
3358common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003359 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003360
Valerio Setti5dfaca42023-09-05 08:48:51 +02003361 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003362 if [ "$test_target" = "ECC_DH" ]; then
3363 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003364 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003365 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003366 fi
3367
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003368 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003369
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003370 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003371
Gilles Peskine21570cf2023-12-22 11:49:50 +01003372 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003373
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003374 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003375 make test
3376
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003377 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003378 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003379}
3380
Valerio Setti4e2f2442023-08-15 10:10:26 +02003381component_test_psa_crypto_config_accel_ecc_no_bignum () {
3382 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3383}
3384
3385component_test_psa_crypto_config_reference_ecc_no_bignum () {
3386 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3387}
3388
3389component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3390 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3391}
3392
3393component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3394 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3395}
3396
Valerio Settiac6d35f2023-08-04 12:49:11 +02003397# Helper for setting common configurations between:
3398# - component_test_tfm_config_p256m_driver_accel_ec()
3399# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003400common_tfm_config () {
3401 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003402 cp configs/config-tfm.h "$CONFIG_H"
3403 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3404 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003405
Yanray Wang73bb2312023-09-25 11:21:15 +08003406 # Other config adjustment to make the tests pass.
3407 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003408 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003409 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3410 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003411
Yanray Wang73bb2312023-09-25 11:21:15 +08003412 # Config adjustment for better test coverage in our environment.
3413 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003414 #
3415 # Enable filesystem I/O for the benefit of PK parse/write tests.
3416 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3417}
3418
Valerio Settiac6d35f2023-08-04 12:49:11 +02003419# Keep this in sync with component_test_tfm_config() as they are both meant
3420# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003421component_test_tfm_config_p256m_driver_accel_ec () {
3422 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3423
3424 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003425
Dave Rodgman897bb772023-11-15 16:34:20 +00003426 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003427 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003428
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003429 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3430 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003431 not grep mbedtls_ecdh_ library/ecdh.o
3432 not grep mbedtls_ecjpake_ library/ecjpake.o
3433 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3434 not grep mbedtls_ecp_ library/ecp.o
3435 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003436 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003437 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003438 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003439 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003440
Valerio Setti5e18b902023-12-04 12:07:30 +01003441 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3442 # files, so we want to ensure that it has not be re-enabled accidentally.
3443 not grep mbedtls_cipher library/cipher.o
3444
Valerio Settib7e95442023-03-21 11:52:33 +01003445 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003446 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003447 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003448}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003449
Valerio Settiac6d35f2023-08-04 12:49:11 +02003450# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3451# they are both meant to be used in analyze_outcomes.py for driver's coverage
3452# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003453component_test_tfm_config() {
3454 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003455
Dave Rodgman897bb772023-11-15 16:34:20 +00003456 # Disable P256M driver, which is on by default, so that analyze_outcomes
3457 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3458 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3459
Valerio Setti52ba0e32023-08-04 12:43:03 +02003460 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003461 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003462
Dave Rodgman897bb772023-11-15 16:34:20 +00003463 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003464 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003465
Valerio Setti5e18b902023-12-04 12:07:30 +01003466 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3467 # files, so we want to ensure that it has not be re-enabled accidentally.
3468 not grep mbedtls_cipher library/cipher.o
3469
Valerio Setti52ba0e32023-08-04 12:43:03 +02003470 msg "test: TF-M config"
3471 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003472}
3473
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003474# Common helper for component_full_without_ecdhe_ecdsa() and
3475# component_full_without_ecdhe_ecdsa_and_tls13() which:
3476# - starts from the "full" configuration minus the list of symbols passed in
3477# as 1st parameter
3478# - build
3479# - test only TLS (i.e. test_suite_tls and ssl-opt)
3480build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003481 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003482
3483 msg "build: full minus something, test TLS"
3484
3485 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003486 for sym in $symbols_to_disable; do
3487 echo "Disabling $sym"
3488 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003489 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003490
Gilles Peskine21570cf2023-12-22 11:49:50 +01003491 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003492
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003493 msg "test: full minus something, test TLS"
3494 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003495
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003496 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003497 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003498}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003499
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003500component_full_without_ecdhe_ecdsa () {
3501 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003502}
3503
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003504component_full_without_ecdhe_ecdsa_and_tls13 () {
3505 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3506 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003507}
3508
Valerio Setti249b18a2023-06-20 12:08:30 +02003509# This is an helper used by:
3510# - component_test_psa_ecc_key_pair_no_derive
3511# - component_test_psa_ecc_key_pair_no_generate
3512# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3513# enabled, but one. Input arguments are as follows:
3514# - $1 is the key type under test, i.e. ECC/RSA/DH
3515# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003516build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003517 key_type=$1
3518 unset_option=$2
3519 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003520
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003521 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003522 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003523 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3524 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3525
3526 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3527 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003528 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003529
Gilles Peskine21570cf2023-12-22 11:49:50 +01003530 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003531
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003532 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003533 make test
3534}
3535
3536component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003537 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003538}
3539
3540component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003541 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003542}
3543
Pengyu Lve705f572023-12-06 16:38:15 +08003544config_psa_crypto_accel_rsa () {
3545 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003546
Pengyu Lve705f572023-12-06 16:38:15 +08003547 # Start from crypto_full config (no X.509, no TLS)
3548 helper_libtestdriver1_adjust_config "crypto_full"
3549
3550 if [ "$driver_only" -eq 1 ]; then
3551 # Remove RSA support and its dependencies
3552 scripts/config.py unset MBEDTLS_RSA_C
3553 scripts/config.py unset MBEDTLS_PKCS1_V15
3554 scripts/config.py unset MBEDTLS_PKCS1_V21
3555
3556 # We need PEM parsing in the test library as well to support the import
3557 # of PEM encoded RSA keys.
3558 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3559 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3560 fi
3561}
3562
3563component_test_psa_crypto_config_accel_rsa_crypto () {
3564 msg "build: crypto_full with accelerated RSA"
3565
3566 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3567 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3568 KEY_TYPE_RSA_PUBLIC_KEY \
3569 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3570 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3571 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3572 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003573
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003574 # Configure
3575 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003576
Pengyu Lve705f572023-12-06 16:38:15 +08003577 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003578
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003579 # Build
3580 # -----
3581
Pengyu Lve705f572023-12-06 16:38:15 +08003582 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003583 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 +08003584 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003585 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003586
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003587 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003588
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003589 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003590 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003591
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003592 # Run the tests
3593 # -------------
3594
Pengyu Lve705f572023-12-06 16:38:15 +08003595 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003596 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003597}
3598
3599component_test_psa_crypto_config_reference_rsa_crypto () {
3600 msg "build: crypto_full with non-accelerated RSA"
3601
3602 # Configure
3603 # ---------
3604 config_psa_crypto_accel_rsa 0
3605
3606 # Build
3607 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003608 make
Pengyu Lve705f572023-12-06 16:38:15 +08003609
3610 # Run the tests
3611 # -------------
3612 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003613 make test
3614}
3615
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003616# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003617# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003618component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003619 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003620
Valerio Setti4590bc22023-06-13 15:39:23 +02003621 # Create a temporary output file unless there is already one set
3622 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3623 REMOVE_OUTCOME_ON_EXIT="no"
3624 else
3625 REMOVE_OUTCOME_ON_EXIT="yes"
3626 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3627 export MBEDTLS_TEST_OUTCOME_FILE
3628 fi
3629
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003630 # Start from crypto configuration
3631 scripts/config.py crypto
3632
3633 # Remove RSA support and its dependencies
3634 scripts/config.py unset MBEDTLS_PKCS1_V15
3635 scripts/config.py unset MBEDTLS_PKCS1_V21
3636 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3637 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3638 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3639 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3640 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3641 scripts/config.py unset MBEDTLS_RSA_C
3642 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3643
3644 # Enable PSA support
3645 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3646
Valerio Setti01cc88a2023-06-15 11:53:08 +02003647 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003648 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003649 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3650 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3651 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003652
3653 make
3654
Valerio Setti01cc88a2023-06-15 11:53:08 +02003655 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003656 make test
3657
3658 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3659 # performing RSA signature.
3660 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3661 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3662
3663 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3664 rm $MBEDTLS_TEST_OUTCOME_FILE
3665 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003666}
3667
Ronald Cronb2312452021-05-08 14:32:59 +02003668component_test_psa_crypto_config_accel_hash () {
3669 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3670
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003671 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3672 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3673 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003674
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003675 # Configure
3676 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003677
Ronald Cron46ac0652024-03-18 12:39:04 +01003678 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003679 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003680
3681 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003682 scripts/config.py unset MBEDTLS_MD5_C
3683 scripts/config.py unset MBEDTLS_RIPEMD160_C
3684 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003685 scripts/config.py unset MBEDTLS_SHA224_C
3686 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003687 scripts/config.py unset MBEDTLS_SHA384_C
3688 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003689 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003690
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003691 # Build
3692 # -----
3693
3694 helper_libtestdriver1_make_drivers "$loc_accel_list"
3695
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003696 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003697
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003698 # There's a risk of something getting re-enabled via config_psa.h;
3699 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3700 not grep mbedtls_md5 library/md5.o
3701 not grep mbedtls_sha1 library/sha1.o
3702 not grep mbedtls_sha256 library/sha256.o
3703 not grep mbedtls_sha512 library/sha512.o
3704 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003705
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003706 # Run the tests
3707 # -------------
3708
Ronald Cronb2312452021-05-08 14:32:59 +02003709 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3710 make test
3711}
3712
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003713component_test_psa_crypto_config_accel_hash_keep_builtins () {
3714 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3715 # This component ensures that all the test cases for
3716 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3717
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003718 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3719 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3720 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003721
Ronald Cron46ac0652024-03-18 12:39:04 +01003722 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003723 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003724
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003725 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003726
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003727 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003728
3729 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3730 make test
3731}
3732
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003733# Auxiliary function to build config for hashes with and without drivers
3734config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003735 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003736 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003737 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003738 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003739 # disable the built-in implementation of hashes
3740 scripts/config.py unset MBEDTLS_MD5_C
3741 scripts/config.py unset MBEDTLS_RIPEMD160_C
3742 scripts/config.py unset MBEDTLS_SHA1_C
3743 scripts/config.py unset MBEDTLS_SHA224_C
3744 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003745 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003746 scripts/config.py unset MBEDTLS_SHA384_C
3747 scripts/config.py unset MBEDTLS_SHA512_C
3748 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003749 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003750 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003751}
3752
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003753# Note that component_test_psa_crypto_config_reference_hash_use_psa
3754# is related to this component and both components need to be kept in sync.
3755# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003756component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003757 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003758
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003759 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3760 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3761 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003762
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003763 # Configure
3764 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003765
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003766 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003767
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003768 # Build
3769 # -----
3770
3771 helper_libtestdriver1_make_drivers "$loc_accel_list"
3772
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003773 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003774
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003775 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003776 # 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 +02003777 not grep mbedtls_md5 library/md5.o
3778 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003779 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003780 not grep mbedtls_sha512 library/sha512.o
3781 not grep mbedtls_ripemd160 library/ripemd160.o
3782
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003783 # Run the tests
3784 # -------------
3785
Gilles Peskine14302ed2023-07-19 19:30:04 +02003786 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003787 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003788
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003789 # This is mostly useful so that we can later compare outcome files with
3790 # the reference config in analyze_outcomes.py, to check that the
3791 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003792 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003793 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003794
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003795 # This is to make sure all ciphersuites are exercised, but we don't need
3796 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003797 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003798 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003799}
3800
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003801# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3802# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3803# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3804# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003805component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003806 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003807
3808 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003809
Gilles Peskine21570cf2023-12-22 11:49:50 +01003810 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003811
Gilles Peskine14302ed2023-07-19 19:30:04 +02003812 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003813 make test
3814
Gilles Peskine14302ed2023-07-19 19:30:04 +02003815 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003816 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003817}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003818
Valerio Setti8eb310c2024-01-22 16:22:57 +01003819# Auxiliary function to build config for hashes with and without drivers
3820config_psa_crypto_hmac_use_psa () {
3821 driver_only="$1"
3822 # start with config full for maximum coverage (also enables USE_PSA)
3823 helper_libtestdriver1_adjust_config "full"
3824
Valerio Setticd89b0b2024-01-24 14:24:55 +01003825 if [ "$driver_only" -eq 1 ]; then
3826 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3827 # is still enabled though (for ENTROPY_C among others).
3828 scripts/config.py unset MBEDTLS_MD_C
3829 # Disable also the builtin hashes since they are supported by the driver
3830 # and MD module is able to perform PSA dispathing.
3831 scripts/config.py unset-all MBEDTLS_SHA
3832 scripts/config.py unset MBEDTLS_MD5_C
3833 scripts/config.py unset MBEDTLS_RIPEMD160_C
3834 fi
3835
Valerio Setti8eb310c2024-01-22 16:22:57 +01003836 # Direct dependencies of MD_C. We disable them also in the reference
3837 # component to work with the same set of features.
3838 scripts/config.py unset MBEDTLS_PKCS7_C
3839 scripts/config.py unset MBEDTLS_PKCS5_C
3840 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3841 scripts/config.py unset MBEDTLS_HKDF_C
3842 # Dependencies of HMAC_DRBG
3843 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3844 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3845}
3846
3847component_test_psa_crypto_config_accel_hmac() {
3848 msg "test: full with accelerated hmac"
3849
3850 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3851 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3852 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3853 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3854
3855 # Configure
3856 # ---------
3857
3858 config_psa_crypto_hmac_use_psa 1
3859
Valerio Setti8eb310c2024-01-22 16:22:57 +01003860 # Build
3861 # -----
3862
3863 helper_libtestdriver1_make_drivers "$loc_accel_list"
3864
3865 helper_libtestdriver1_make_main "$loc_accel_list"
3866
3867 # Ensure that built-in support for HMAC is disabled.
3868 not grep mbedtls_md_hmac library/md.o
3869
3870 # Run the tests
3871 # -------------
3872
3873 msg "test: full with accelerated hmac"
3874 make test
3875}
3876
3877component_test_psa_crypto_config_reference_hmac() {
3878 msg "test: full without accelerated hmac"
3879
3880 config_psa_crypto_hmac_use_psa 0
3881
3882 make
3883
3884 msg "test: full without accelerated hmac"
3885 make test
3886}
3887
Valerio Setti9da01a72023-12-18 17:38:18 +01003888component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003889 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003890
Valerio Setti9da01a72023-12-18 17:38:18 +01003891 # Albeit this components aims at accelerating DES which should only support
3892 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3893 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003894 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3895 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3896 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003897
Valerio Setti9da01a72023-12-18 17:38:18 +01003898 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3899 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3900 # of this component. This limitation will be addressed by #8598.
3901
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003902 # Configure
3903 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003904
Valerio Setti9a427302023-10-17 11:40:42 +02003905 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003906 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003907
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003908 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003909 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3910 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3911 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3912 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3913 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3914 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3915 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003916 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003917
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003918 # Build
3919 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003920
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003921 helper_libtestdriver1_make_drivers "$loc_accel_list"
3922
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003923 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003924
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003925 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003926 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003927
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003928 # Run the tests
3929 # -------------
3930
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003931 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003932 make test
3933}
3934
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003935component_test_psa_crypto_config_accel_aead () {
3936 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3937
Valerio Setti3f02bb72023-10-02 15:57:33 +02003938 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3939 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003940
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003941 # Configure
3942 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003943
Valerio Setti3f02bb72023-10-02 15:57:33 +02003944 # Start from full config
3945 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003946
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003947 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003948 scripts/config.py unset MBEDTLS_GCM_C
3949 scripts/config.py unset MBEDTLS_CCM_C
3950 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003951
Valerio Settia50b89e2023-11-08 15:58:47 +01003952 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3953 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003954
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003955 # Build
3956 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003957
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003958 helper_libtestdriver1_make_drivers "$loc_accel_list"
3959
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003960 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003961
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003962 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003963 not grep mbedtls_ccm library/ccm.o
3964 not grep mbedtls_gcm library/gcm.o
3965 not grep mbedtls_chachapoly library/chachapoly.o
3966
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003967 # Run the tests
3968 # -------------
3969
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003970 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3971 make test
3972}
3973
Valerio Settib680fc42023-10-13 09:29:37 +02003974# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003975# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3976# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3977common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003978 # Start from the full config
3979 helper_libtestdriver1_adjust_config "full"
3980
Valerio Settib680fc42023-10-13 09:29:37 +02003981 scripts/config.py unset MBEDTLS_NIST_KW_C
3982}
3983
Valerio Settib6b301f2023-10-04 12:05:05 +02003984# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003985# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3986# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003987# are meant to be used together in analyze_outcomes.py script in order to test
3988# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003989component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3990 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003991
Valerio Settiad8b7f02023-10-25 12:39:50 +02003992 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 +01003993 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003994 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003995 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3996
3997 # Configure
3998 # ---------
3999
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004000 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004001
4002 # Disable the things that are being accelerated
4003 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4004 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4005 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4006 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4007 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4008 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4009 scripts/config.py unset MBEDTLS_GCM_C
4010 scripts/config.py unset MBEDTLS_CCM_C
4011 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004012 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004013 scripts/config.py unset MBEDTLS_DES_C
4014 scripts/config.py unset MBEDTLS_AES_C
4015 scripts/config.py unset MBEDTLS_ARIA_C
4016 scripts/config.py unset MBEDTLS_CHACHA20_C
4017 scripts/config.py unset MBEDTLS_CAMELLIA_C
4018
Valerio Settiec9b2582023-11-08 16:50:54 +01004019 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4020 # does not depend on it.
4021 scripts/config.py unset MBEDTLS_CIPHER_C
4022
Valerio Settib6b301f2023-10-04 12:05:05 +02004023 # Build
4024 # -----
4025
4026 helper_libtestdriver1_make_drivers "$loc_accel_list"
4027
4028 helper_libtestdriver1_make_main "$loc_accel_list"
4029
4030 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004031 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004032 not grep mbedtls_des library/des.o
4033 not grep mbedtls_aes library/aes.o
4034 not grep mbedtls_aria library/aria.o
4035 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004036 not grep mbedtls_ccm library/ccm.o
4037 not grep mbedtls_gcm library/gcm.o
4038 not grep mbedtls_chachapoly library/chachapoly.o
4039 not grep mbedtls_cmac library/cmac.o
4040
4041 # Run the tests
4042 # -------------
4043
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004044 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004045 make test
Valerio Settif9414552023-11-09 10:43:20 +01004046
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004047 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004048 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004049
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004050 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004051 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004052}
4053
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004054component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4055 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4056 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004057
Gilles Peskine21570cf2023-12-22 11:49:50 +01004058 make
Valerio Settif9414552023-11-09 10:43:20 +01004059
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004060 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004061 make test
Valerio Settif9414552023-11-09 10:43:20 +01004062
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004063 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004064 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004065
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004066 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004067 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004068}
4069
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004070common_block_cipher_dispatch() {
4071 TEST_WITH_DRIVER="$1"
4072
4073 # Start from the full config
4074 helper_libtestdriver1_adjust_config "full"
4075
4076 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4077 # Disable key types that are accelerated (there is no legacy equivalent
4078 # symbol for ECB)
4079 scripts/config.py unset MBEDTLS_AES_C
4080 scripts/config.py unset MBEDTLS_ARIA_C
4081 scripts/config.py unset MBEDTLS_CAMELLIA_C
4082 fi
4083
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004084 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004085 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004086 # Keep this also in the reference component in order to skip the same tests
4087 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004088 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4089 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4090 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4091 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4092 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4093 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4094 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Cron7d949ae2024-05-15 18:31:17 +02004095 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004096
4097 # Disable direct dependency on AES_C
4098 scripts/config.py unset MBEDTLS_NIST_KW_C
4099
4100 # Prevent the cipher module from using deprecated PSA path. The reason is
4101 # that otherwise there will be tests relying on "aes_info" (defined in
4102 # "cipher_wrap.c") whose functions are not available when AES_C is
4103 # not defined. ARIA and Camellia are not a problem in this case because
4104 # the PSA path is not tested for these key types.
4105 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4106}
4107
Valerio Settif8e6cba2023-12-12 11:53:39 +01004108component_test_full_block_cipher_psa_dispatch () {
4109 msg "build: full + PSA dispatch in block_cipher"
4110
4111 loc_accel_list="ALG_ECB_NO_PADDING \
4112 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4113
4114 # Configure
4115 # ---------
4116
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004117 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004118
Valerio Settif8e6cba2023-12-12 11:53:39 +01004119 # Build
4120 # -----
4121
4122 helper_libtestdriver1_make_drivers "$loc_accel_list"
4123
4124 helper_libtestdriver1_make_main "$loc_accel_list"
4125
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004126 # Make sure disabled components were not re-enabled by accident (additive
4127 # config)
4128 not grep mbedtls_aes_ library/aes.o
4129 not grep mbedtls_aria_ library/aria.o
4130 not grep mbedtls_camellia_ library/camellia.o
4131
Valerio Settif8e6cba2023-12-12 11:53:39 +01004132 # Run the tests
4133 # -------------
4134
4135 msg "test: full + PSA dispatch in block_cipher"
4136 make test
4137}
4138
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004139# This is the reference component of component_test_full_block_cipher_psa_dispatch
4140component_test_full_block_cipher_legacy_dispatch () {
4141 msg "build: full + legacy dispatch in block_cipher"
4142
4143 common_block_cipher_dispatch 0
4144
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004145 make
4146
4147 msg "test: full + legacy dispatch in block_cipher"
4148 make test
4149}
4150
Gilles Peskine36dea152023-07-20 22:19:45 +02004151component_test_aead_chachapoly_disabled() {
4152 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004153 scripts/config.py full
4154 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004155 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004156 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004157
Gilles Peskine36dea152023-07-20 22:19:45 +02004158 msg "test: full minus CHACHAPOLY"
4159 make test
4160}
4161
4162component_test_aead_only_ccm() {
4163 msg "build: full minus CHACHAPOLY and GCM"
4164 scripts/config.py full
4165 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4166 scripts/config.py unset MBEDTLS_GCM_C
4167 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4168 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004169 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004170
4171 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004172 make test
4173}
4174
Ronald Crone501d0e2023-07-10 08:31:19 +02004175component_test_ccm_aes_sha256() {
4176 msg "build: CCM + AES + SHA256 configuration"
4177
Ronald Cron7612d8c2023-07-20 10:03:54 +02004178 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004179 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004180
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004181 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004182
4183 msg "test: CCM + AES + SHA256 configuration"
4184 make test
4185}
4186
John Durkopd0321952020-10-29 21:37:36 -07004187# 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 -08004188component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004189 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004190 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004191 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004192 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004193 scripts/config.py unset MBEDTLS_ECDH_C
4194 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4195 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4196 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4197 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4198 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4199 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004200 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004201}
4202
4203# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004204component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004205 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004206 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004207 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004208 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004209 # 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 +01004210 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 -07004211}
4212
4213# 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 -08004214component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004215 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004216 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004217 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
4218 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004219 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4220 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004221 # 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 +01004222 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 -07004223}
4224
John Durkop1b7ee052020-11-27 08:51:22 -08004225# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4226component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004227 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004228 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004229 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004230 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004231 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4232 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4233 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4234 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4235 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4236 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4237 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004238 scripts/config.py unset MBEDTLS_LMS_C
4239 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004240 # 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 +01004241 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 -08004242}
4243
4244# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4245component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004246 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004247 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004248 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004249 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004250 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4251 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4252 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4253 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4254 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4255 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4256 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004257 scripts/config.py unset MBEDTLS_LMS_C
4258 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004259 # 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 +01004260 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 -08004261}
4262
4263# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4264component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004265 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004266 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004267 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004268 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004269 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4270 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4271 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4272 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4273 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4274 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4275 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004276 scripts/config.py unset MBEDTLS_LMS_C
4277 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004278 # 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 +01004279 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 -08004280}
4281
4282# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4283component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004284 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004285 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004286 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004287 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004288 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4289 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4290 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4291 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4292 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4293 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004294 # 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 +01004295 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 -08004296}
4297
4298# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4299component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004300 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004301 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004302 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004303 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004304 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4305 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4306 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4307 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4308 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4309 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004310 # 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 +01004311 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 -08004312}
4313
4314# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4315component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004316 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004317 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004318 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004319 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004320 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4321 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4322 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4323 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4324 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4325 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004326 scripts/config.py unset MBEDTLS_LMS_C
4327 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004328 # 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 +01004329 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 -08004330}
4331
4332# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4333component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004334 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004335 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004336 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004337 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004338 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4339 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4340 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4341 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4342 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4343 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4344 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004345 scripts/config.py unset MBEDTLS_LMS_C
4346 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004347 # 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 +01004348 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 -08004349}
4350
John Durkopd0321952020-10-29 21:37:36 -07004351# 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 -08004352component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004353 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 -07004354 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004355 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004356 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004357 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4358 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4359 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4360 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004361 # 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 +01004362 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 -07004363}
4364
4365# 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 -08004366component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004367 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 -07004368 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004369 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004370 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004371 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4372 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4373 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4374 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004375 # 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 +01004376 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 -07004377}
4378
4379# 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 -08004380component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004381 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 -07004382 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004383 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004384 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004385 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4386 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4387 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4388 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004389 # 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 +01004390 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 -07004391}
4392
4393# 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 -08004394component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004395 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 -07004396 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004397 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004398 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004399 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4400 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4401 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4402 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004403 # 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 +01004404 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 -07004405}
4406
4407# 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 -08004408component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004409 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 -07004410 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004411 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004412 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004413 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4414 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4415 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4416 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4417 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004418 # 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 +01004419 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 -07004420}
4421
4422# 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 -08004423component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004424 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 -07004425 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004426 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004427 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004428 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4429 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004430 # 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 +01004431 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 -07004432}
4433
Dave Rodgmanc164c072023-06-28 09:43:23 +01004434
Dave Rodgman904c5892023-06-28 17:36:02 +01004435support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004436 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004437}
4438
Dave Rodgman904c5892023-06-28 17:36:02 +01004439component_build_tfm_armcc() {
4440 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004441 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004442
Dave Rodgman88651c42023-06-29 12:35:51 +01004443 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004444 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 +01004445}
4446
4447component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004448 # Check that the TF-M configuration can build cleanly with various
4449 # warning flags enabled. We don't build or run tests, since the
4450 # TF-M configuration needs a TF-M platform. A tweaked version of
4451 # the configuration that works on mainstream platforms is in
4452 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004453 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004454
Dave Rodgman88651c42023-06-29 12:35:51 +01004455 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004456 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 +01004457
Dave Rodgman904c5892023-06-28 17:36:02 +01004458 msg "build: TF-M config, gcc native build"
4459 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004460 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 +01004461}
4462
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004463# Test that the given .o file builds with all (valid) combinations of the given options.
4464#
4465# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4466#
4467# The validator function is the name of a function to validate the combination of options.
4468# It may be "" if all combinations are valid.
4469# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004470# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004471build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004472 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004473 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004474 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004475 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004476 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004477
Dave Rodgman42436102023-10-03 15:47:05 +01004478 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004479 for opt in "${options[@]}"; do
4480 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004481 done
4482
4483 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004484 cd $(dirname ${file})
4485 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004486
Dave Rodgman920343a2023-10-01 18:41:09 +01004487 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004488 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 +01004489
Dave Rodgman42436102023-10-03 15:47:05 +01004490 # Extract the command generated by the Makefile to build the target file.
4491 # This ensures that we have any include paths, macro definitions, etc
4492 # that may be applied by make.
4493 # 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 +01004494 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004495
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004496 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004497 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004498
Dave Rodgman28e38d82023-10-04 11:50:30 +01004499 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004500 source_file=${file%.o}.c
4501
4502 targets=0
4503 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004504
Dave Rodgman28e38d82023-10-04 11:50:30 +01004505 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004506 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004507 # each bit of $i is used to determine if options[i] will be set or not
4508 target="t"
4509 clang_args=""
4510 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004511 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004512 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004513 clang_args="${clang_args} ${opt}"
4514 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004515 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004516 done
4517
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004518 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004519 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004520 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004521 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004522
Dave Rodgman28e38d82023-10-04 11:50:30 +01004523 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004524 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004525 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004526 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004527
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004528 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004529
Dave Rodgman920343a2023-10-01 18:41:09 +01004530 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004531 make -s -f ${makefile} build_test_config_combos
4532 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004533
4534 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004535 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004536}
4537
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004538validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004539 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4540 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004541 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004542 fi
4543 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4544 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004545 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004546 fi
4547 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004548 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004549}
4550
4551component_build_aes_variations() {
4552 # 18s - around 90ms per clang invocation on M1 Pro
4553 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004554 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004555 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004556
Yanray Wangbc29aef2023-11-06 11:08:17 +08004557 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004558 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004559
Dave Rodgman42436102023-10-03 15:47:05 +01004560 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004561 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4562 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4563 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4564 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004565
4566 cd "$MBEDTLS_ROOT_DIR"
4567 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4568
Yanray Wang42be1ba2023-11-23 14:28:47 +08004569 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004570 # manually set or unset those configurations to check
4571 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004572 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4573 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4574 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4575 scripts/config.py unset MBEDTLS_DES_C
4576 scripts/config.py unset MBEDTLS_NIST_KW_C
4577 build_test_config_combos library/aes.o validate_aes_config_variations \
4578 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4579 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4580 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4581 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004582}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004583
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004584component_test_no_platform () {
4585 # Full configuration build, without platform support, file IO and net sockets.
4586 # This should catch missing mbedtls_printf definitions, and by disabling file
4587 # IO, it should catch missing '#include <stdio.h>'
4588 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004589 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004590 scripts/config.py unset MBEDTLS_PLATFORM_C
4591 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004592 scripts/config.py unset MBEDTLS_FS_IO
4593 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004594 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004595 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004596 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004597 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598 # to re-enable platform integration features otherwise disabled in C99 builds
4599 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004600 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004601}
Gilles Peskine7c652162017-12-11 00:01:40 +01004602
4603component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004604 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004605 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4606 scripts/config.py full
4607 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004608 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4609 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4610 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4611 make
4612}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004613
Gilles Peskine8f073122018-11-27 15:58:47 +01004614component_build_no_ssl_srv () {
4615 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004616 scripts/config.py full
4617 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004618 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004619}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004620
Gilles Peskine8f073122018-11-27 15:58:47 +01004621component_build_no_ssl_cli () {
4622 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004623 scripts/config.py full
4624 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004625 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004626}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004627
Gilles Peskine8f073122018-11-27 15:58:47 +01004628component_build_no_sockets () {
4629 # Note, C99 compliance can also be tested with the sockets support disabled,
4630 # as that requires a POSIX platform (which isn't the same as C99).
4631 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004632 scripts/config.py full
4633 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4634 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4635 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4636}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004637
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004638component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004639 msg "build: default config with memory buffer allocator and backtrace enabled"
4640 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4641 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4642 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004643 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004644 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004645 make
4646
4647 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4648 make test
4649}
4650
4651component_test_memory_buffer_allocator () {
4652 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004653 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4654 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004655 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004656 make
4657
4658 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4659 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004660
4661 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4662 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004663 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004664}
4665
Gilles Peskine8f073122018-11-27 15:58:47 +01004666component_test_no_max_fragment_length () {
4667 # Run max fragment length tests with MFL disabled
4668 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004669 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004670 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004671 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004672
Gilles Peskine8f073122018-11-27 15:58:47 +01004673 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004674 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004675}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004676
Hanno Becker545ced42019-02-19 11:10:48 +00004677component_test_asan_remove_peer_certificate () {
4678 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004679 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004680 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004681 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004682 make
4683
4684 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4685 make test
4686
4687 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004688 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004689
4690 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004691 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004692
4693 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004694 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004695}
4696
Gilles Peskine8f073122018-11-27 15:58:47 +01004697component_test_no_max_fragment_length_small_ssl_out_content_len () {
4698 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004699 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4700 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4701 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004702 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004703 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004704
Gilles Peskine8f073122018-11-27 15:58:47 +01004705 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004706 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004707
4708 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004709 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004710}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004711
Darryl Greenaad82f92019-12-02 10:53:11 +00004712component_test_variable_ssl_in_out_buffer_len () {
4713 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4714 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004715 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004716 make
4717
4718 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4719 make test
4720
4721 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004722 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004723
4724 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004725 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004726}
4727
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004728component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004729 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004730 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004731
Dave Rodgman17127e92023-12-14 16:42:48 +00004732 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004733 make
4734
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004735 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004736 make test
4737
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004738 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004739 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004740
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004741 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004742 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004743}
4744
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004745component_test_ssl_alloc_buffer_and_mfl () {
4746 msg "build: default config with memory buffer allocator and MFL extension"
4747 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4748 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4749 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4750 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4751 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004752 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004753 make
4754
4755 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4756 make test
4757
4758 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 +02004759 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004760}
4761
Gilles Peskine636c26a2020-03-04 20:46:15 +01004762component_test_when_no_ciphersuites_have_mac () {
4763 msg "build: when no ciphersuites have MAC"
4764 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004765 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004766 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004767 make
4768
Ronald Cron7b66beb2024-05-27 08:14:27 +02004769 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004770 make test
4771
Ronald Cron7b66beb2024-05-27 08:14:27 +02004772 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004773 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004774}
4775
Raoul Strackxa4e86142020-06-15 17:03:13 +02004776component_test_no_date_time () {
4777 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4778 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004779 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004780 make
4781
4782 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4783 make test
4784}
4785
Gilles Peskine8f073122018-11-27 15:58:47 +01004786component_test_platform_calloc_macro () {
4787 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004788 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4789 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4790 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004791 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004792 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004793
Gilles Peskine8f073122018-11-27 15:58:47 +01004794 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4795 make test
4796}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004797
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004798component_test_malloc_0_null () {
4799 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004800 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004801 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 +02004802
4803 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4804 make test
4805
4806 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4807 # Just the calloc selftest. "make test" ran the others as part of the
4808 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004809 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004810
4811 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4812 # Run a subset of the tests. The choice is a balance between coverage
4813 # and time (including time indirectly wasted due to flaky tests).
4814 # The current choice is to skip tests whose description includes
4815 # "proxy", which is an approximation of skipping tests that use the
4816 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004817 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004818}
4819
Dave Rodgman6a08b682023-06-19 11:51:33 +01004820support_test_aesni() {
4821 # Check that gcc targets x86_64 (we can build AESNI), and check for
4822 # AESNI support on the host (we can run AESNI).
4823 #
4824 # The name of this function is possibly slightly misleading, but needs to align
4825 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004826 #
4827 # In principle 32-bit x86 can support AESNI, but our implementation does not
4828 # support 32-bit x86, so we check for x86-64.
4829 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004830 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4831 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004832 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004833}
4834
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004835component_test_aesni () { # ~ 60s
4836 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4837 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4838 #
4839 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4840 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4841 # exercise the plain C impl).
4842
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004843 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004844 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004845 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004846 scripts/config.py set MBEDTLS_HAVE_ASM
4847
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004848 # test the intrinsics implementation
4849 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004850 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004851 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004852 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004853 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004854
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004855 # test the asm implementation
4856 msg "AES tests, test assembly"
4857 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004858 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004859 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004860 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004861
4862 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004863 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004864 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004865 msg "AES tests, plain C"
4866 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004867 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004868 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004869 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004870 not grep -q "AES note: using AESNI" ./programs/test/selftest
4871 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004872
4873 # test the intrinsics implementation
4874 scripts/config.py set MBEDTLS_AESNI_C
4875 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4876 msg "AES tests, test AESNI only"
4877 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004878 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004879 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4880 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004881 grep -q "AES note: using AESNI" ./programs/test/selftest
4882 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004883}
4884
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004885component_test_sha3_variations() {
4886 msg "sha3 loop unroll variations"
4887
4888 # define minimal config sufficient to test SHA3
4889 cat > include/mbedtls/mbedtls_config.h << END
4890 #define MBEDTLS_SELF_TEST
4891 #define MBEDTLS_SHA3_C
4892END
4893
4894 msg "all loops unrolled"
4895 make clean
4896 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"
4897 ./tests/test_suite_shax
4898
4899 msg "all loops rolled up"
4900 make clean
4901 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"
4902 ./tests/test_suite_shax
4903}
4904
Jerry Yub6d39c22023-08-16 15:11:48 +08004905support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004906 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004907}
4908
4909component_test_aesni_m32 () { # ~ 60s
4910 # This tests are duplicated from component_test_aesni for i386 target
4911 #
4912 # AESNI intrinsic code supports i386 and assembly code does not support it.
4913
4914 msg "build: default config with different AES implementations"
4915 scripts/config.py set MBEDTLS_AESNI_C
4916 scripts/config.py set MBEDTLS_PADLOCK_C
4917 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4918 scripts/config.py set MBEDTLS_HAVE_ASM
4919
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004920 # test the intrinsics implementation with gcc
4921 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004922 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004923 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004924 # check that we built intrinsics - this should be used by default when supported by the compiler
4925 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4926 grep -q "AES note: using AESNI" ./programs/test/selftest
4927 grep -q "AES note: built-in implementation." ./programs/test/selftest
4928 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4929 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4930
4931 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004932 scripts/config.py unset MBEDTLS_PADLOCK_C
4933 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4934 msg "AES tests, test AESNI only"
4935 make clean
4936 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4937 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4938 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4939 grep -q "AES note: using AESNI" ./programs/test/selftest
4940 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4941 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4942 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4943}
4944
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004945support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004946 # clang >= 4 is required to build with target attributes
4947 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004948}
4949
4950component_test_aesni_m32_clang() {
4951
4952 scripts/config.py set MBEDTLS_AESNI_C
4953 scripts/config.py set MBEDTLS_PADLOCK_C
4954 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4955 scripts/config.py set MBEDTLS_HAVE_ASM
4956
4957 # test the intrinsics implementation with clang
4958 msg "AES tests, test intrinsics (clang)"
4959 make clean
4960 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4961 # check that we built intrinsics - this should be used by default when supported by the compiler
4962 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4963 grep -q "AES note: using AESNI" ./programs/test/selftest
4964 grep -q "AES note: built-in implementation." ./programs/test/selftest
4965 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4966 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4967}
4968
Jerry Yu193cbc02023-08-03 17:06:29 +08004969# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4970component_build_aes_aesce_armcc () {
4971 msg "Build: AESCE test on arm64 platform without plain C."
4972 scripts/config.py baremetal
4973
4974 # armc[56] don't support SHA-512 intrinsics
4975 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4976
4977 # Stop armclang warning about feature detection for A64_CRYPTO.
4978 # With this enabled, the library does build correctly under armclang,
4979 # but in baremetal builds (as tested here), feature detection is
4980 # unavailable, and the user is notified via a #warning. So enabling
4981 # this feature would prevent us from building with -Werror on
4982 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004983 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004984 scripts/config.py set MBEDTLS_HAVE_ASM
4985
4986 msg "AESCE, build with default configuration."
4987 scripts/config.py set MBEDTLS_AESCE_C
4988 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4989 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4990
4991 msg "AESCE, build AESCE only"
4992 scripts/config.py set MBEDTLS_AESCE_C
4993 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4994 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4995}
4996
Dave Rodgman0c584032023-10-08 12:26:54 +01004997support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004998 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004999 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01005000}
5001
5002component_build_aes_armce () {
5003 # Test variations of AES with Armv8 crypto extensions
5004 scripts/config.py set MBEDTLS_AESCE_C
5005 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5006
5007 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01005008 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005009
5010 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5011 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5012
5013 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5014 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5015
Dave Rodgman5e419372023-10-23 15:30:20 +01005016 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01005017
Dave Rodgman5e419372023-10-23 15:30:20 +01005018 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
5019 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005020
Dave Rodgman5e419372023-10-23 15:30:20 +01005021 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5022 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01005023
Dave Rodgman5e419372023-10-23 15:30:20 +01005024 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5025 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01005026
5027 # test for presence of AES instructions
5028 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5029 msg "clang, test A32 crypto instructions built"
5030 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5031 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5032 msg "clang, test T32 crypto instructions built"
5033 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5034 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5035 msg "clang, test aarch64 crypto instructions built"
5036 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5037 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
5038
5039 # test for absence of AES instructions
5040 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
5041 scripts/config.py unset MBEDTLS_AESCE_C
5042 msg "clang, test A32 crypto instructions not built"
5043 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5044 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5045 msg "clang, test T32 crypto instructions not built"
5046 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5047 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5048 msg "clang, test aarch64 crypto instructions not built"
5049 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5050 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01005051}
5052
Dave Rodgman9ed18532023-10-05 00:06:47 +01005053support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00005054 # clang >= 4 is required to build with SHA extensions
5055 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01005056}
5057
Dave Rodgmand9e80832023-10-04 17:17:46 +01005058component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01005059 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005060
5061
5062 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01005063 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005064 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
5065 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5066 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
5067 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5068 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005069
Dave Rodgmand9e80832023-10-04 17:17:46 +01005070
Dave Rodgman94a634d2023-10-10 12:59:29 +01005071 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005072 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005073 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
5074 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5075 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005076
Dave Rodgman5b89c552023-10-10 14:59:02 +01005077 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005078 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
5079 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5080 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01005081
Dave Rodgmancd654002023-10-05 09:40:07 +01005082
Dave Rodgman94a634d2023-10-10 12:59:29 +01005083 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005084 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005085 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
5086 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
5087 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
5088 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5089 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005090
Dave Rodgmancd654002023-10-05 09:40:07 +01005091
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005092 # examine the disassembly for presence of SHA instructions
5093 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5094 scripts/config.py set ${opt}
5095 msg "${opt} clang, test A32 crypto instructions built"
5096 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5097 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5098
5099 msg "${opt} clang, test T32 crypto instructions built"
5100 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5101 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5102
5103 msg "${opt} clang, test aarch64 crypto instructions built"
5104 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5105 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5106 scripts/config.py unset ${opt}
5107 done
5108
5109
5110 # examine the disassembly for absence of SHA instructions
5111 msg "clang, test A32 crypto instructions not built"
5112 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5113 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5114
5115 msg "clang, test T32 crypto instructions not built"
5116 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5117 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5118
5119 msg "clang, test aarch64 crypto instructions not built"
5120 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5121 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005122}
5123
Jerry Yuc935aa62023-08-03 17:08:27 +08005124# For timebeing, no VIA Padlock platform available.
5125component_build_aes_via_padlock () {
5126
5127 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005128 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005129 scripts/config.py set MBEDTLS_PADLOCK_C
5130 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005131 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005132 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005133
5134}
5135
5136support_build_aes_via_padlock_only () {
5137 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5138 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5139 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5140}
5141
Jerry Yu193cbc02023-08-03 17:06:29 +08005142support_build_aes_aesce_armcc () {
5143 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005144}
5145
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005146component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005147 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005148 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005149 scripts/config.py unset MBEDTLS_PADLOCK_C
5150
Dave Rodgmand8d64512023-12-19 12:20:21 +00005151 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005152
5153 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5154 make test
5155}
5156
5157component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5158 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5159 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005160 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5161 scripts/config.py unset MBEDTLS_PADLOCK_C
5162
Hanno Becker83ebf782017-07-07 12:29:15 +01005163 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005164
5165 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005166 make test
5167}
Gilles Peskine8f073122018-11-27 15:58:47 +01005168
Hanno Becker83ebf782017-07-07 12:29:15 +01005169component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005170 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5171 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5172 scripts/config.py unset MBEDTLS_PADLOCK_C
5173 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005174 scripts/config.py unset MBEDTLS_AESCE_C
5175
Dave Rodgmand8d64512023-12-19 12:20:21 +00005176 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005177
5178 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005179 make test
5180
5181 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5182 programs/test/selftest
5183}
5184
Matthias Schulz0767fda2024-02-07 10:46:28 +01005185component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005186 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5187 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005188 scripts/config.py unset MBEDTLS_PADLOCK_C
5189 scripts/config.py unset MBEDTLS_AESNI_C
5190 scripts/config.py unset MBEDTLS_AESCE_C
5191
5192 make CFLAGS='-O2 -Werror -Wall -Wextra'
5193
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005194 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005195 make test
5196}
5197
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005198component_test_aes_fewer_tables () {
5199 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005200 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005201 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005202
Gilles Peskine7c652162017-12-11 00:01:40 +01005203 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005204 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005205}
5206
5207component_test_aes_rom_tables () {
5208 msg "build: default config with AES_ROM_TABLES enabled"
5209 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005210 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005211
5212 msg "test: AES_ROM_TABLES"
5213 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005214}
5215
Gilles Peskine14c3c062018-01-29 21:25:12 +01005216component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005217 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5218 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5219 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005220 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005221
Gilles Peskine8f073122018-11-27 15:58:47 +01005222 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5223 make test
5224}
5225
Yanray Wang49cd4b52023-11-10 11:58:37 +08005226# helper for common_block_cipher_no_decrypt() which:
5227# - enable/disable the list of config options passed from -s/-u respectively.
5228# - build
5229# - test for tests_suite_xxx
5230# - selftest
5231#
5232# Usage: helper_block_cipher_no_decrypt_build_test
5233# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5234# Options: -s set_opts the list of config options to enable
5235# -u unset_opts the list of config options to disable
5236# -c cflags the list of options passed to CFLAGS
5237# -l ldflags the list of options passed to LDFLAGS
5238helper_block_cipher_no_decrypt_build_test () {
5239 while [ $# -gt 0 ]; do
5240 case "$1" in
5241 -s)
5242 shift; local set_opts="$1";;
5243 -u)
5244 shift; local unset_opts="$1";;
5245 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005246 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005247 -l)
5248 shift; local ldflags="$1";;
5249 esac
5250 shift
5251 done
5252 set_opts="${set_opts:-}"
5253 unset_opts="${unset_opts:-}"
5254 cflags="${cflags:-}"
5255 ldflags="${ldflags:-}"
5256
Yanray Wangb2d6e522023-11-13 16:57:47 +08005257 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5258 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005259
5260 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5261 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005262 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005263
5264 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5265 not grep mbedtls_aes_setkey_dec library/aes.o
5266 not grep mbedtls_aria_setkey_dec library/aria.o
5267 not grep mbedtls_camellia_setkey_dec library/camellia.o
5268 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5269 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005270 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5271 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005272
5273 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5274 make test
5275
5276 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5277 programs/test/selftest
5278}
5279
5280# This is a common configuration function used in:
5281# - component_test_block_cipher_no_decrypt_aesni_legacy()
5282# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5283# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5284# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5285# on x86.
5286common_block_cipher_no_decrypt () {
5287 # test AESNI intrinsics
5288 helper_block_cipher_no_decrypt_build_test \
5289 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005290 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005291
5292 # test AESNI assembly
5293 helper_block_cipher_no_decrypt_build_test \
5294 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005295 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005296
5297 # test AES C implementation
5298 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005299 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005300
5301 # test AESNI intrinsics for i386 target
5302 helper_block_cipher_no_decrypt_build_test \
5303 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005304 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005305 -l "-m32"
5306}
5307
Yanray Wang3ae11992023-11-13 17:32:09 +08005308# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5309# usage: 0: no PSA crypto configuration
5310# 1: use PSA crypto configuration
5311config_block_cipher_no_decrypt () {
5312 use_psa=$1
5313
Yanray Wang66111392023-10-31 18:54:54 +08005314 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005315 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5316 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005317 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005318 scripts/config.py unset MBEDTLS_NIST_KW_C
5319
Yanray Wang3ae11992023-11-13 17:32:09 +08005320 if [ "$use_psa" -eq 1 ]; then
5321 # Enable support for cryptographic mechanisms through the PSA API.
5322 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5323 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5324 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5325 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5326 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5327 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5328 fi
5329}
5330
5331component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005332 # This consistently causes an llvm crash on clang 3.8, so use gcc
5333 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005334 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005335 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005336}
5337
Yanray Wangf1496402023-11-01 18:55:13 +08005338component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005339 # This consistently causes an llvm crash on clang 3.8, so use gcc
5340 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005341 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005342 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005343}
5344
Yanray Wang66111392023-10-31 18:54:54 +08005345support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005346 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005347}
5348
Yanray Wang66111392023-10-31 18:54:54 +08005349component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005350 scripts/config.py baremetal
5351
5352 # armc[56] don't support SHA-512 intrinsics
5353 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5354
5355 # Stop armclang warning about feature detection for A64_CRYPTO.
5356 # With this enabled, the library does build correctly under armclang,
5357 # but in baremetal builds (as tested here), feature detection is
5358 # unavailable, and the user is notified via a #warning. So enabling
5359 # this feature would prevent us from building with -Werror on
5360 # armclang. Tracked in #7198.
5361 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5362 scripts/config.py set MBEDTLS_HAVE_ASM
5363
Yanray Wang3ae11992023-11-13 17:32:09 +08005364 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005365
5366 # test AESCE baremetal build
5367 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005368 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005369 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005370
Yanray Wangef1b04d2023-09-08 11:09:26 +08005371 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5372 not grep mbedtls_aes_setkey_dec library/aes.o
5373 not grep mbedtls_aria_setkey_dec library/aria.o
5374 not grep mbedtls_camellia_setkey_dec library/camellia.o
5375 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5376 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005377 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005378 not grep mbedtls_aesce_inverse_key library/aesce.o
5379 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005380}
5381
Gilles Peskine592f5912019-10-07 18:49:32 +02005382component_test_ctr_drbg_aes_256_sha_256 () {
5383 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5384 scripts/config.py full
5385 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5386 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005387 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005388 make
5389
5390 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5391 make test
5392}
5393
5394component_test_ctr_drbg_aes_128_sha_512 () {
5395 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005396 scripts/config.py full
5397 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5398 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005399 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005400 make
5401
5402 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5403 make test
5404}
5405
5406component_test_ctr_drbg_aes_128_sha_256 () {
5407 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005408 scripts/config.py full
5409 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5410 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5411 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005412 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005413 make
5414
5415 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5416 make test
5417}
5418
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005419component_test_se_default () {
5420 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005421 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005422 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005423
5424 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5425 make test
5426}
5427
Steven Cooremand57203d2020-07-16 20:28:59 +02005428component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005429 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005430 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005431 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005432 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5433 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005434 loc_cflags="${loc_cflags} -I../tests/include -O2"
5435
Gilles Peskine21570cf2023-12-22 11:49:50 +01005436 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005437
Gilles Peskine1997f302023-07-26 18:45:20 +02005438 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005439 make test
5440}
5441
Gilles Peskine8f073122018-11-27 15:58:47 +01005442component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005443 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005444 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005445 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005446 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005447}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005448
Gilles Peskinecf740502019-07-03 20:43:05 +02005449component_test_cmake_shared () {
5450 msg "build/test: cmake shared" # ~ 2min
5451 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5452 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005453 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005454 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005455 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005456}
5457
Gilles Peskineec10bf12019-09-20 19:56:06 +02005458test_build_opt () {
5459 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005460 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005461 for opt in "$@"; do
5462 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005463 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005464 # We're confident enough in compilers to not run _all_ the tests,
5465 # but at least run the unit tests. In particular, runs with
5466 # optimizations use inline assembly whereas runs with -O0
5467 # skip inline assembly.
5468 make test # ~30s
5469 make clean
5470 done
5471}
5472
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005473# For FreeBSD we invoke the function by name so this condition is added
5474# to disable the existing test_clang_opt function for linux.
5475if [[ $(uname) != "Linux" ]]; then
5476 component_test_clang_opt () {
5477 scripts/config.py full
5478 test_build_opt 'full config' clang -O0 -Os -O2
5479 }
5480fi
5481
5482component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005483 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005484 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005485}
5486support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005487 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005488}
5489
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005490component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005491 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005492 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005493}
5494support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005495 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005496}
5497
5498component_test_gcc_latest_opt () {
5499 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005500 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005501}
5502support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005503 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005504}
5505
5506component_test_gcc_earliest_opt () {
5507 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005508 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005509}
5510support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005511 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005512}
5513
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005514component_build_mbedtls_config_file () {
5515 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005516 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005517 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005518 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005519 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005520 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5521 make clean
5522
5523 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5524 # In the user config, disable one feature (for simplicity, pick a feature
5525 # that nothing else depends on).
5526 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005527 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005528 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5529
5530 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005531}
5532
Gilles Peskine7d904e72022-04-07 21:59:14 +02005533component_build_psa_config_file () {
5534 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5535 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5536 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5537 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5538 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005539 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005540 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5541 make clean
5542
5543 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Cron7d949ae2024-05-15 18:31:17 +02005544 # In the user config, disable one feature and its dependencies, which will
5545 # reflect on the mbedtls configuration so we can query it with
5546 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005547 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Cron7d949ae2024-05-15 18:31:17 +02005548 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005549 scripts/config.py unset MBEDTLS_CMAC_C
5550 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5551 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5552
5553 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005554}
5555
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005556component_build_psa_alt_headers () {
5557 msg "build: make with PSA alt headers" # ~20s
5558
5559 # Generate alternative versions of the substitutable headers with the
5560 # same content except different include guards.
5561 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5562
5563 # Build the library and some programs.
5564 # Don't build the fuzzers to avoid having to go through hoops to set
5565 # a correct include path for programs/fuzz/Makefile.
5566 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
5567 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\"'"
5568
5569 # Check that we're getting the alternative include guards and not the
5570 # original include guards.
5571 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5572 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5573 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5574 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5575}
5576
Dave Rodgman852de3c2023-12-14 14:46:45 +00005577component_test_m32_no_asm () {
5578 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005579 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005580 #
5581 # Note that we require gcc, because clang Asan builds fail to link for
5582 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005583 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005584 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005585 scripts/config.py unset MBEDTLS_HAVE_ASM
5586 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005587 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005588 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005589
Dave Rodgman852de3c2023-12-14 14:46:45 +00005590 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005591 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005592}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005593support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005594 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005595 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005596 *) false;;
5597 esac
5598}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005599
Gilles Peskineff0aee02021-10-05 09:36:03 +02005600component_test_m32_o2 () {
5601 # Build with optimization, to use the i386 specific inline assembly
5602 # and go faster for tests.
5603 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005604 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005605 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005606 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005607
Gilles Peskineff0aee02021-10-05 09:36:03 +02005608 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005609 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005610
Gilles Peskineff0aee02021-10-05 09:36:03 +02005611 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005612 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005613}
Gilles Peskinecf522222021-10-07 19:25:29 +02005614support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005615 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005616}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005617
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005618component_test_m32_everest () {
5619 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005620 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005621 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005622 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005623
5624 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5625 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005626
5627 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005628 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005629
5630 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5631 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005632 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005633}
5634support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005635 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005636}
5637
Gilles Peskine8f073122018-11-27 15:58:47 +01005638component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005639 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005640 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005641 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005642
5643 msg "test: 64-bit ILP32, make, gcc"
5644 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005645}
Gilles Peskine878cf602019-01-06 20:50:38 +00005646support_test_mx32 () {
5647 case $(uname -m) in
5648 amd64|x86_64) true;;
5649 *) false;;
5650 esac
5651}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005652
Peter Kolbus60c6da22018-12-27 06:59:04 -06005653component_test_min_mpi_window_size () {
5654 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005655 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005656 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005657 make
5658
5659 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5660 make test
5661}
5662
Gilles Peskine8f073122018-11-27 15:58:47 +01005663component_test_have_int32 () {
5664 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005665 scripts/config.py unset MBEDTLS_HAVE_ASM
5666 scripts/config.py unset MBEDTLS_AESNI_C
5667 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005668 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005669 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005670
Gilles Peskine8f073122018-11-27 15:58:47 +01005671 msg "test: gcc, force 32-bit bignum limbs"
5672 make test
5673}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005674
Gilles Peskine8f073122018-11-27 15:58:47 +01005675component_test_have_int64 () {
5676 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005677 scripts/config.py unset MBEDTLS_HAVE_ASM
5678 scripts/config.py unset MBEDTLS_AESNI_C
5679 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005680 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005681 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005682
Gilles Peskine8f073122018-11-27 15:58:47 +01005683 msg "test: gcc, force 64-bit bignum limbs"
5684 make test
5685}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005686
Gabor Mezeie256cc12023-07-26 17:28:48 +02005687component_test_have_int32_cmake_new_bignum () {
5688 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5689 scripts/config.py unset MBEDTLS_HAVE_ASM
5690 scripts/config.py unset MBEDTLS_AESNI_C
5691 scripts/config.py unset MBEDTLS_PADLOCK_C
5692 scripts/config.py unset MBEDTLS_AESCE_C
5693 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005694 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005695 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005696
5697 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5698 make test
5699}
5700
Gilles Peskine8f073122018-11-27 15:58:47 +01005701component_test_no_udbl_division () {
5702 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005703 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005704 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005705 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005706
Gilles Peskine8f073122018-11-27 15:58:47 +01005707 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5708 make test
5709}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005710
Gilles Peskine8f073122018-11-27 15:58:47 +01005711component_test_no_64bit_multiplication () {
5712 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005713 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005714 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005715 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005716
Gilles Peskine8f073122018-11-27 15:58:47 +01005717 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5718 make test
5719}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005720
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005721component_test_no_strings () {
5722 msg "build: no strings" # ~10s
5723 scripts/config.py full
5724 # Disable options that activate a large amount of string constants.
5725 scripts/config.py unset MBEDTLS_DEBUG_C
5726 scripts/config.py unset MBEDTLS_ERROR_C
5727 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5728 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005729 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005730
5731 msg "test: no strings" # ~ 10s
5732 make test
5733}
5734
Hanno Beckerc5722d12020-10-09 11:10:42 +01005735component_test_no_x509_info () {
5736 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5737 scripts/config.pl full
5738 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5739 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005740 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005741
5742 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5743 make test
5744
5745 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005746 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005747}
5748
Gilles Peskine8f073122018-11-27 15:58:47 +01005749component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005750 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005751 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005752 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 +02005753
Gilles Peskinee36fe812021-09-01 20:00:33 +02005754 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005755 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005756}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005757
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005758component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005759 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005760 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005761 # Build for a target platform that's close to what Debian uses
5762 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005763 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005764 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005765 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005766 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'
5767
Gilles Peskinee36fe812021-09-01 20:00:33 +02005768 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005769 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005770}
5771support_build_arm_linux_gnueabi_gcc_arm5vte () {
5772 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5773}
5774
5775component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005776 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005777 scripts/config.py baremetal
5778 # This is an imperfect substitute for
5779 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005780 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005781 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 +02005782
Gilles Peskinee36fe812021-09-01 20:00:33 +02005783 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005784 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005785}
5786
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005787component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005788 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5789 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005790 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 +02005791
Gilles Peskinee36fe812021-09-01 20:00:33 +02005792 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005793 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005794 for lib in library/*.a; do
5795 echo "$lib:"
5796 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5797 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005798}
5799
Gilles Peskine8f073122018-11-27 15:58:47 +01005800component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005801 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005802 scripts/config.py baremetal
5803 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005804 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 +01005805 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005806 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005807}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005808
Gilles Peskine8f073122018-11-27 15:58:47 +01005809component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005810 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005811 scripts/config.py baremetal
5812 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005813 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 +01005814 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005815 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005816}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005817
Dave Rodgman8c315f22023-06-02 10:26:24 -04005818component_build_arm_clang_thumb () {
5819 # ~ 30s
5820
5821 scripts/config.py baremetal
5822
5823 msg "build: clang thumb 2, make"
5824 make clean
5825 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5826
5827 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5828 msg "build: clang thumb 1 -O0, make"
5829 make clean
5830 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5831
5832 msg "build: clang thumb 1 -Os, make"
5833 make clean
5834 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5835}
5836
Gilles Peskine8f073122018-11-27 15:58:47 +01005837component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005838 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005839 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005840 # armc[56] don't support SHA-512 intrinsics
5841 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005842
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005843 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5844 scripts/config.py unset MBEDTLS_AESCE_C
5845
Dave Rodgman0fddf822023-03-02 15:32:12 +00005846 # Stop armclang warning about feature detection for A64_CRYPTO.
5847 # With this enabled, the library does build correctly under armclang,
5848 # but in baremetal builds (as tested here), feature detection is
5849 # unavailable, and the user is notified via a #warning. So enabling
5850 # this feature would prevent us from building with -Werror on
5851 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005852 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005853
Hanno Beckerf0762e92022-07-15 12:08:19 +01005854 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005855
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005856 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005857
5858 msg "size: ARM Compiler 5"
5859 "$ARMC5_FROMELF" -z library/*.o
5860
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005861 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005862
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005863 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005864 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005865
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005866 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005867 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5868
5869 # ARM Compiler 6 - Target ARMv7-M+DSP
5870 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005871
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005872 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005873 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005874
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005875 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005876 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005877
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005878 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5879 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5880
Dave Rodgman99318e62023-05-24 12:27:42 +01005881 # ARM Compiler 6 - Target Cortex-M0
5882 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005883
5884 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5885 #
5886 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5887 # that we have in our CI
5888 scripts/config.py set MBEDTLS_AESCE_C
5889 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005890}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005891
Pengyu Lvdf070032023-02-24 16:03:31 +08005892support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005893 armc5_cc="$ARMC5_BIN_DIR/armcc"
5894 armc6_cc="$ARMC6_BIN_DIR/armclang"
5895 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005896}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005897
Ronald Crond2cb7f42024-03-18 12:49:18 +01005898component_test_tls12_only () {
5899 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5900 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5901 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5902 make
5903
5904 msg "test: main suites (inc. selftests) (ASan build)"
5905 make test
5906
5907 msg "test: ssl-opt.sh (ASan build)"
5908 tests/ssl-opt.sh
5909
5910 msg "test: compat.sh (ASan build)"
5911 tests/compat.sh
5912}
5913
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005914component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005915 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005916 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005917 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005918 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5919
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005920 msg "test: TLS 1.3 only, all key exchange modes enabled"
5921 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005922
Ronald Cronc3f43b62022-10-17 17:35:32 +02005923 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5924 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005925}
5926
Ronald Cronc3f43b62022-10-17 17:35:32 +02005927component_test_tls13_only_psk () {
5928 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5929 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5930 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5931 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005932 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005933 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5934 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5935 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5936 scripts/config.py unset MBEDTLS_ECDSA_C
5937 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005938 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005939 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005940 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5941
Ronald Cronc3f43b62022-10-17 17:35:32 +02005942 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5943 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005944
Ronald Cronc3f43b62022-10-17 17:35:32 +02005945 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5946 tests/ssl-opt.sh
5947}
5948
5949component_test_tls13_only_ephemeral () {
5950 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5951 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5952 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005953 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005954 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5955
5956 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5957 cd tests; ./test_suite_ssl; cd ..
5958
5959 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5960 tests/ssl-opt.sh
5961}
5962
Przemek Stekiela01c2422023-06-13 10:46:48 +02005963component_test_tls13_only_ephemeral_ffdh () {
5964 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5965 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5966 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5967 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005968 scripts/config.py unset MBEDTLS_ECDH_C
5969
Przemek Stekiela01c2422023-06-13 10:46:48 +02005970 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5971
5972 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5973 cd tests; ./test_suite_ssl; cd ..
5974
5975 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5976 tests/ssl-opt.sh
5977}
5978
Ronald Cronc3f43b62022-10-17 17:35:32 +02005979component_test_tls13_only_psk_ephemeral () {
5980 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5981 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5982 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5983 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5984 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5985 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5986 scripts/config.py unset MBEDTLS_ECDSA_C
5987 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005988 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005989 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005990 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5991
5992 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5993 cd tests; ./test_suite_ssl; cd ..
5994
5995 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5996 tests/ssl-opt.sh
5997}
5998
Przemek Stekiela01c2422023-06-13 10:46:48 +02005999component_test_tls13_only_psk_ephemeral_ffdh () {
6000 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
6001 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
6002 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6003 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6004 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6005 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6006 scripts/config.py unset MBEDTLS_ECDSA_C
6007 scripts/config.py unset MBEDTLS_PKCS1_V21
6008 scripts/config.py unset MBEDTLS_PKCS7_C
6009 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02006010 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02006011 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6012
6013 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6014 cd tests; ./test_suite_ssl; cd ..
6015
6016 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6017 tests/ssl-opt.sh
6018}
6019
Ronald Cronc3f43b62022-10-17 17:35:32 +02006020component_test_tls13_only_psk_all () {
6021 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
6022 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6023 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6024 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6025 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6026 scripts/config.py unset MBEDTLS_ECDSA_C
6027 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00006028 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01006029 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006030 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6031
6032 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6033 cd tests; ./test_suite_ssl; cd ..
6034
6035 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6036 tests/ssl-opt.sh
6037}
6038
6039component_test_tls13_only_ephemeral_all () {
6040 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
6041 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01006042 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006043 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6044
6045 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6046 cd tests; ./test_suite_ssl; cd ..
6047
6048 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6049 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02006050}
6051
Ronald Cron46ac0652024-03-18 12:39:04 +01006052component_test_tls13_no_padding () {
6053 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006054 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01006055 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006056 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006057 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006058 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006059 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01006060 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006061 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006062}
6063
Ronald Cron6f135e12021-12-08 16:57:54 +01006064component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01006065 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006066 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01006067 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006068 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01006069 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006070 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006071 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01006072 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006073 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006074}
6075
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006076component_test_full_minus_session_tickets() {
6077 msg "build: full config without session tickets"
6078 scripts/config.py full
Norbert Fabritius06d99342023-04-11 15:40:05 +02006079 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006080 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritius06d99342023-04-11 15:40:05 +02006081 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
6082 make
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006083 msg "test: full config without session tickets"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006084 make test
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006085 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006086 tests/ssl-opt.sh
6087}
6088
Gilles Peskine8f073122018-11-27 15:58:47 +01006089component_build_mingw () {
6090 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006091 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 +00006092
Gilles Peskine8f073122018-11-27 15:58:47 +01006093 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006094 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 +01006095 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02006096
Gilles Peskine8f073122018-11-27 15:58:47 +01006097 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006098 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
6099 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 +01006100 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006101
Pengyu Lv158eead2023-10-19 11:27:05 +08006102 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006103 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08006104 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 +01006105 make WINDOWS_BUILD=1 clean
6106}
Jaeden Amero117b8a42019-04-17 15:19:26 +01006107support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08006108 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
6109 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01006110 *) true;;
6111 esac
6112}
Simon Butcher91aef332016-11-17 09:20:50 +00006113
Gilles Peskine8f073122018-11-27 15:58:47 +01006114component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006115 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02006116 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006117 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6118 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006119
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006120 msg "test: main suites (MSan)" # ~ 10s
6121 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006122
Gilles Peskine6848d172023-11-02 19:58:03 +01006123 msg "test: metatests (MSan)"
6124 tests/scripts/run-metatests.sh any msan
6125
Gilles Peskine82b27272019-06-14 18:27:03 +02006126 msg "program demos (MSan)" # ~20s
6127 tests/scripts/run_demos.py
6128
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006129 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006130 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006131
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006132 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006133
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006134 if [ "$MEMORY" -gt 0 ]; then
6135 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006136 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006137 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006138}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006139
Bence Szépkúti0354d042023-12-06 16:14:37 +01006140component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006141 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006142 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006143 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6144 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006145
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006146 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006147 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006148
Gilles Peskine636c26a2020-03-04 20:46:15 +01006149 # Optional parts (slow; currently broken on OS X because programs don't
6150 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006151 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006152 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006153 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006154 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006155 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006156
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006157 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006158 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006159 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006160 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006161
6162 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006163 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006164 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006165 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006166}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006167
Bence Szépkúti0354d042023-12-06 16:14:37 +01006168component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006169 msg "build: Release, full (clang)"
6170 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6171 scripts/config.py full
6172 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6173 make
6174
6175 msg "test: main suites, Valgrind (full config)"
6176 make memcheck
6177}
6178
Paul Elliott62dc3922021-11-25 17:29:40 +00006179support_test_cmake_out_of_source () {
6180 distrib_id=""
6181 distrib_ver=""
6182 distrib_ver_minor=""
6183 distrib_ver_major=""
6184
6185 # Attempt to parse lsb-release to find out distribution and version. If not
6186 # found this should fail safe (test is supported).
6187 if [[ -f /etc/lsb-release ]]; then
6188
6189 while read -r lsb_line; do
6190 case "$lsb_line" in
6191 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6192 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6193 esac
6194 done < /etc/lsb-release
6195
6196 distrib_ver_major="${distrib_ver%%.*}"
6197 distrib_ver="${distrib_ver#*.}"
6198 distrib_ver_minor="${distrib_ver%%.*}"
6199 fi
6200
6201 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6202 # processor (as the CI does) can create a race condition whereby the build
6203 # fails to see a generated file, despite that file actually having been
6204 # generated. This problem appears to go away with 18.04 or newer, so make
6205 # the out of source tests unsupported on Ubuntu 16.04.
6206 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6207}
6208
Gilles Peskine8f073122018-11-27 15:58:47 +01006209component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006210 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006211 # generates
6212 make neat
6213
Gilles Peskine8f073122018-11-27 15:58:47 +01006214 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006215 MBEDTLS_ROOT_DIR="$PWD"
6216 mkdir "$OUT_OF_SOURCE_DIR"
6217 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006218 # Note: Explicitly generate files as these are turned off in releases
6219 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006220 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006221
Gilles Peskine8f073122018-11-27 15:58:47 +01006222 msg "test: cmake 'out-of-source' build"
6223 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006224 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006225 # Also ensure that there are no error messages such as
6226 # "No such file or directory", which would indicate that some required
6227 # file is missing (ssl-opt.sh tolerates the absence of some files so
6228 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006229 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006230 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006231 cat ssl-opt.err >&2
6232 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006233 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006234 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006235 cd "$MBEDTLS_ROOT_DIR"
6236 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006237}
Andres AGdc192212016-08-31 17:33:13 +01006238
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006239component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006240 # Remove existing generated files so that we use the ones CMake
6241 # generates
6242 make neat
6243
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006244 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006245 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006246 # Note: Explicitly generate files as these are turned off in releases
6247 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006248 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006249 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006250}
Gilles Peskinea3000992022-02-04 00:21:12 +01006251support_test_cmake_as_subdirectory () {
6252 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006253}
6254
Chris Kayd259e342021-03-25 16:03:25 +00006255component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006256 # Remove existing generated files so that we use the ones CMake
6257 # generates
6258 make neat
6259
Chris Kayd259e342021-03-25 16:03:25 +00006260 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006261 cd programs/test/cmake_package
6262 cmake .
6263 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006264 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006265}
Gilles Peskinea3000992022-02-04 00:21:12 +01006266support_test_cmake_as_package () {
6267 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006268}
6269
6270component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006271 # Remove existing generated files so that we use the ones CMake
6272 # generates
6273 make neat
6274
Chris Kayd259e342021-03-25 16:03:25 +00006275 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006276 cd programs/test/cmake_package_install
6277 cmake .
6278 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006279 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006280}
Gilles Peskinea3000992022-02-04 00:21:12 +01006281support_test_cmake_as_package_install () {
6282 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006283}
6284
David Horstmann20550e32023-01-12 14:17:01 +00006285component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006286 # Make a copy of config file to use for the in-tree test
6287 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006288
6289 MBEDTLS_ROOT_DIR="$PWD"
6290 mkdir "$OUT_OF_SOURCE_DIR"
6291 cd "$OUT_OF_SOURCE_DIR"
6292
David Horstmann969c1452023-01-31 10:34:44 +00006293 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006294 cmake "$MBEDTLS_ROOT_DIR"
6295 make
6296
6297 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6298 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006299 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006300 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6301 make
6302
6303 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6304 # In the user config, disable one feature (for simplicity, pick a feature
6305 # that nothing else depends on).
6306 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6307
6308 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6309 make
6310 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6311
6312 rm -f user_config.h full_config.h
6313
6314 cd "$MBEDTLS_ROOT_DIR"
6315 rm -rf "$OUT_OF_SOURCE_DIR"
6316
6317 # Now repeat the test for an in-tree build:
6318
David Horstmann969c1452023-01-31 10:34:44 +00006319 # Restore config for the in-tree test
6320 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006321
David Horstmann969c1452023-01-31 10:34:44 +00006322 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006323 cmake .
6324 make
6325
6326 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6327 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006328 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006329 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6330 make
6331
6332 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6333 # In the user config, disable one feature (for simplicity, pick a feature
6334 # that nothing else depends on).
6335 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6336
6337 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6338 make
6339 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6340
6341 rm -f user_config.h full_config.h
6342}
6343support_build_cmake_custom_config_file () {
6344 support_test_cmake_out_of_source
6345}
6346
David Horstmann90dddc62024-05-10 14:37:48 +01006347component_build_cmake_programs_no_testing () {
David Horstmanndf097d32024-05-10 15:37:57 +01006348 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann90dddc62024-05-10 14:37:48 +01006349 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6350 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6351 make
6352}
6353support_build_cmake_programs_no_testing () {
6354 support_test_cmake_out_of_source
6355}
David Horstmann20550e32023-01-12 14:17:01 +00006356
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006357component_build_zeroize_checks () {
6358 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6359
6360 scripts/config.py full
6361
6362 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006363 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 +01006364}
6365
6366
Gilles Peskine8f073122018-11-27 15:58:47 +01006367component_test_zeroize () {
6368 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6369 # different combinations of compilers and optimization flags by using an
6370 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6371 # system in all cases that the script fails, so we must manually search the
6372 # output to check whether the pass string is present and no failure strings
6373 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006374
Gilles Peskine4976e822019-01-06 19:52:22 +00006375 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6376 # about a spurious message if Gdb tries and fails, so suppress that.
6377 gdb_disable_aslr=
6378 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6379 gdb_disable_aslr='set disable-randomization off'
6380 fi
6381
Gilles Peskine8f073122018-11-27 15:58:47 +01006382 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006383 for compiler in clang gcc; do
6384 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6385 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006386 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6387 grep "The buffer was correctly zeroized" test_zeroize.log
6388 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006389 rm -f test_zeroize.log
6390 make clean
6391 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006392 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006393}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006394
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006395component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006396 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006397 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006398 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006399
6400 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006401 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006402}
6403
6404support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006405 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006406 ver="$(cmake --version)"
6407 ver="${ver#cmake version }"
6408 ver_major="${ver%%.*}"
6409
6410 ver="${ver#*.}"
6411 ver_minor="${ver%%.*}"
6412
6413 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006414}
6415
Gilles Peskinec848d222022-12-09 12:23:35 +01006416component_check_code_style () {
6417 msg "Check C code style"
6418 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006419}
6420
Gilles Peskinec848d222022-12-09 12:23:35 +01006421support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006422 case $(uncrustify --version) in
6423 *0.75.1*) true;;
6424 *) false;;
6425 esac
6426}
6427
Gilles Peskine8f073122018-11-27 15:58:47 +01006428component_check_python_files () {
6429 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006430 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006431}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006432
Joe Subbianid614c0b2021-07-29 11:18:29 +01006433component_check_test_helpers () {
6434 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006435 # unittest writes out mundane stuff like number or tests run on stderr.
6436 # Our convention is to reserve stderr for actual errors, and write
6437 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannea091522024-05-29 17:57:08 +01006438 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006439
Joe Subbiania25ffab2021-08-06 09:41:27 +01006440 msg "unit test: translate_ciphers.py"
6441 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006442}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006443
Jerry Yud767cc42023-03-31 15:03:55 +08006444
Gilles Peskine192c72f2017-12-21 15:59:21 +01006445################################################################
6446#### Termination
6447################################################################
6448
Gilles Peskine8f073122018-11-27 15:58:47 +01006449post_report () {
6450 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006451 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006452
Gilles Peskine8f073122018-11-27 15:58:47 +01006453 final_report
6454}
6455
6456
6457
6458################################################################
6459#### Run all the things
6460################################################################
6461
Gilles Peskine5d996822020-03-28 21:09:21 +01006462# Function invoked by --error-test to test error reporting.
6463pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006464 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006465 if [ $KEEP_GOING -ne 0 ]; then
6466 echo "Expect three failing commands."
6467 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006468 # If the component doesn't run in a subshell, changing error_test_i to an
6469 # invalid integer will cause an error in the loop that runs this function.
6470 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006471 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006472 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006473 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006474 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006475 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006476 make unknown_target
6477 false "this should not be executed"
6478}
6479
Gilles Peskinee48351a2018-11-27 16:06:30 +01006480# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006481run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006482 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006483 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006484
6485 # Unconditionally create a seedfile that's sufficiently long.
6486 # Do this before each component, because a previous component may
6487 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006488 local dd_cmd
6489 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6490 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006491 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006492 esac
6493 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006494
Gilles Peskineec135542021-08-02 23:14:03 +02006495 # Run the component in a subshell, with error trapping and output
6496 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006497 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006498 # We want to keep running if the subshell fails, so 'set -e' must
6499 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006500 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006501 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006502 (
6503 if [ $QUIET -eq 1 ]; then
6504 # msg() will be silenced, so just print the component name here.
6505 echo "${current_component#component_}"
6506 exec >/dev/null
6507 fi
6508 if [ $KEEP_GOING -eq 1 ]; then
6509 # Keep "set -e" off, and run an ERR trap instead to record failures.
6510 set -E
6511 trap err_trap ERR
6512 fi
6513 # The next line is what runs the component
6514 "$@"
6515 if [ $KEEP_GOING -eq 1 ]; then
6516 trap - ERR
6517 exit $last_failure_status
6518 fi
6519 )
6520 component_status=$?
6521 if [ $KEEP_GOING -eq 1 ]; then
6522 set -e
6523 if [ $component_status -ne 0 ]; then
6524 failure_count=$((failure_count + 1))
6525 fi
6526 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006527
6528 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006529 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006530 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006531}
6532
6533# Preliminary setup
6534pre_check_environment
6535pre_initialize_variables
6536pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006537
Dave Rodgman21900632024-02-26 11:41:19 +00006538setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006539pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006540pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006541pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006542
Gilles Peskine878cf602019-01-06 20:50:38 +00006543build_status=0
6544if [ $KEEP_GOING -eq 1 ]; then
6545 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006546fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006547pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006548pre_print_configuration
6549pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006550cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006551if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006552 pre_generate_files
6553fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006554
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006555# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006556for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006557 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006558done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006559unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006560for component in $RUN_COMPONENTS; do
6561 run_component "component_$component"
6562done
Gilles Peskine8f073122018-11-27 15:58:47 +01006563
6564# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006565post_report