blob: 18f515c33207f8a3540beb9faa248ae9737f9d88 [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
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 Cronc5e81d22024-04-02 14:39:53 +0200198 if [ -n "${OPENSSL_3+set}" ]; then
199 export OPENSSL_NEXT="$OPENSSL_3"
200 fi
201
Gilles Peskine396853a2021-09-20 18:57:55 +0200202 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000203 export CTEST_OUTPUT_ON_FAILURE=1
204
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100206 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200207 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000208 # Normally, tests should use this compiler for ASAN testing
209 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200210
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400211 # Platform tests have an allocation that returns null
212 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400213 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400214
Gilles Peskine878cf602019-01-06 20:50:38 +0000215 # Gather the list of available components. These are the functions
216 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100217 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000218
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000219 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100220 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100221}
Andres AG38495a32016-07-12 16:54:33 +0100222
Dave Rodgman21900632024-02-26 11:41:19 +0000223setup_quiet_wrappers()
224{
225 # Pick up "quiet" wrappers for make and cmake, which don't output very much
226 # unless there is an error. This reduces logging overhead in the CI.
227 #
228 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000229 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
230 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000231 fi
232}
233
Gilles Peskinea28db922019-01-10 00:05:18 +0100234# Test whether the component $1 is included in the command line patterns.
235is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100236{
Gilles Peskine03af6782021-08-06 11:35:17 +0200237 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
238 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000240 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100241 set +f
242 case ${1#component_} in $pattern) return 0;; esac
243 done
244 set +f
245 return 1
246}
Andres AG7770ea82016-10-10 15:46:20 +0100247
Simon Butcher41eeccf2016-09-07 00:07:09 +0100248usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100249{
Gilles Peskine709346a2017-12-10 23:43:39 +0100250 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100251Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100252Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100253By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100254COMPONENT can be the name of a component or a shell wildcard pattern.
255
256Examples:
257 $0 "check_*"
258 Run all sanity checks.
259 $0 --no-armcc --except test_memsan
260 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100261
262Special options:
263 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000264 --list-all-components List all available test components and exit.
265 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100266
267General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200268 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100270 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100271 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200272 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200273 --arm-none-eabi-gcc-prefix=<string>
274 Prefix for a cross-compiler for arm-none-eabi
275 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200276 --arm-linux-gnueabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-linux-gnueabi
278 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100279 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200280 --restore First clean up the build tree, restoring backed up
281 files. Do not run any components unless they are
282 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100283 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200284 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100285 --except Exclude the COMPONENTs listed on the command line,
286 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200287 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100288 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100289 --no-force Refuse to overwrite modified files (default).
290 --no-keep-going Stop at the first error (default).
291 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800292 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100293 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --outcome-file=<path> File where test outcomes are written (not done if
295 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200297 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100298 -s|--seed Integer seed value to use for this test run.
299
300Tool path options:
301 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
302 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100303 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
304 --clang-latest=<Clang_latest_path> Latest version of clang available
305 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
306 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100307 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
308 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100310 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100311EOF
SimonB2e23c822016-04-16 21:54:39 +0100312}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200314# Cleanup before/after running a component.
315# Remove built files as well as the cmake cache/config.
316# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100317cleanup()
318{
David Horstmann76a77382023-08-17 17:32:26 +0100319 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100320 command make clean
321 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200322
Gilles Peskine31b07e22018-03-21 12:15:06 +0100323 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000324 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100325 -iname CMakeFiles -exec rm -rf {} \+ -o \
326 \( -iname cmake_install.cmake -o \
327 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200328 -iname CMakeCache.txt -o \
329 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200331 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200332
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100333 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
334 rm -rf programs/test/cmake_subproject/build
335 rm -f programs/test/cmake_subproject/Makefile
336 rm -f programs/test/cmake_subproject/cmake_subproject
337
Chris Kayd259e342021-03-25 16:03:25 +0000338 # Remove any artifacts from the component_test_cmake_as_package test.
339 rm -rf programs/test/cmake_package/build
340 rm -f programs/test/cmake_package/Makefile
341 rm -f programs/test/cmake_package/cmake_package
342
343 # Remove any artifacts from the component_test_cmake_as_installed_package test.
344 rm -rf programs/test/cmake_package_install/build
345 rm -f programs/test/cmake_package_install/Makefile
346 rm -f programs/test/cmake_package_install/cmake_package_install
347
Gilles Peskinef83eb822020-03-30 20:11:39 +0200348 # Restore files that may have been clobbered by the job
349 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200350 if [[ -e "$x$backup_suffix" ]]; then
351 cp -p "$x$backup_suffix" "$x"
352 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 done
354}
John Durkopbd069d32020-10-31 22:14:03 -0700355
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200356# Final cleanup when this script exits (except when exiting on a failure
357# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358final_cleanup () {
359 cleanup
360
361 for x in $files_to_back_up; do
362 rm -f "$x$backup_suffix"
363 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100364}
365
Gilles Peskine7c652162017-12-11 00:01:40 +0100366# Executed on exit. May be redefined depending on command line options.
367final_report () {
368 :
369}
370
371fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200372 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100373 final_report $1
374 trap - $1
375 kill -$1 $$
376}
377
378trap 'fatal_signal HUP' HUP
379trap 'fatal_signal INT' INT
380trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200381
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200382# Number of processors on this machine. Used as the default setting
383# for parallel make.
384all_sh_nproc ()
385{
386 {
387 nproc || # Linux
388 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
389 sysctl -n hw.ncpu || # FreeBSD
390 echo 1
391 } 2>/dev/null
392}
393
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100394msg()
395{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100396 if [ -n "${current_component:-}" ]; then
397 current_section="${current_component#component_}: $1"
398 else
399 current_section="$1"
400 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200401
402 if [ $QUIET -eq 1 ]; then
403 return
404 fi
405
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo ""
407 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100408 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000409 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100410 echo "******************************************************************"
411}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100412
Gilles Peskine8f073122018-11-27 15:58:47 +0100413armc6_build_test()
414{
415 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100416
Gilles Peskine18487f62020-04-30 23:11:54 +0200417 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800418 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100419 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000420 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200421
422 msg "size: ARM Compiler 6 ($FLAGS)"
423 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100424}
Andres AGa5cd9732016-10-17 15:23:10 +0100425
Andres AGd9eba4b2016-08-26 14:42:14 +0100426err_msg()
427{
428 echo "$1" >&2
429}
430
431check_tools()
432{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200433 for tool in "$@"; do
434 if ! `type "$tool" >/dev/null 2>&1`; then
435 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100436 exit 1
437 fi
438 done
439}
440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000442 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100443 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100444 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100445 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200446 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000447 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100448
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000449 # Note that legacy options are ignored instead of being omitted from this
450 # list of options, so invocations that worked with previous version of
451 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100452 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100453 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200454 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200455 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200456 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000457 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100458 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
459 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100460 --clang-earliest) shift; CLANG_EARLIEST="$1";;
461 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100462 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000463 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100464 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100465 --gcc-earliest) shift; GCC_EARLIEST="$1";;
466 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200468 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
469 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-serv) shift; GNUTLS_SERV="$1";;
471 --help|-h) usage; exit;;
472 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000473 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100474 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200476 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000477 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --no-force) FORCE=0;;
479 --no-keep-going) KEEP_GOING=0;;
480 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200481 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100482 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200486 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200488 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200489 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --seed|-s) shift; SEED="$1";;
491 -*)
492 echo >&2 "Unknown option: $1"
493 echo >&2 "Run $0 --help for usage."
494 exit 120
495 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000496 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 esac
498 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100499 done
SimonB2e23c822016-04-16 21:54:39 +0100500
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100501 # Exclude components that are not supported on this platform.
502 SUPPORTED_COMPONENTS=
503 for component in $ALL_COMPONENTS; do
504 case $(type "support_$component" 2>&1) in
505 *' function'*)
506 if ! support_$component; then continue; fi;;
507 esac
508 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
509 done
510
511 if [ $list_components -eq 1 ]; then
512 printf '%s\n' $SUPPORTED_COMPONENTS
513 exit
514 fi
515
Gilles Peskinea28db922019-01-10 00:05:18 +0100516 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200517 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000518 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100519 fi
520
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000521 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
522 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100523 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100525 fi
SimonB2e23c822016-04-16 21:54:39 +0100526
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200527 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 if [ $all_except -eq 0 ]; then
529 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200530 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
531 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200532 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200534 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200535 # If the requested name includes a wildcard character, don't
536 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100537 case $component in
538 *[*?\[]*) continue;;
539 esac
540 case " $SUPPORTED_COMPONENTS " in
541 *" $component "*) :;;
542 *)
543 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
544 unsupported=$((unsupported + 1));;
545 esac
546 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200547 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100548 if [ $unsupported -ne 0 ]; then
549 exit 2
550 fi
551 fi
552
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000553 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100554 RUN_COMPONENTS=
555 for component in $SUPPORTED_COMPONENTS; do
556 if is_component_included "$component"; [ $? -eq $all_except ]; then
557 RUN_COMPONENTS="$RUN_COMPONENTS $component"
558 fi
559 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560
561 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000562 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100563}
SimonB2e23c822016-04-16 21:54:39 +0100564
Gilles Peskine8f073122018-11-27 15:58:47 +0100565pre_check_git () {
566 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100567 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 git checkout-index -f -q $CONFIG_H
569 cleanup
570 else
SimonB2e23c822016-04-16 21:54:39 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
573 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
574 echo "You can either delete this directory manually, or force the test by rerunning"
575 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
576 exit 1
577 fi
578
Ronald Cron7a93ac52023-07-20 09:49:12 +0200579 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100580 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100581 echo "You can either delete or preserve your work, or force the test by rerunning the"
582 echo "script as: $0 --force"
583 exit 1
584 fi
SimonB2e23c822016-04-16 21:54:39 +0100585 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500586}
587
Gilles Peskine568f53a2021-07-12 18:16:01 +0200588pre_restore_files () {
589 # If the makefiles have been generated by a framework such as cmake,
590 # restore them from git. If the makefiles look like modifications from
591 # the ones checked into git, take care not to modify them. Whatever
592 # this function leaves behind is what the script will restore before
593 # each component.
594 case "$(head -n1 Makefile)" in
595 *[Gg]enerated*)
596 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
597 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
598 ;;
599 esac
600}
601
Gilles Peskinef83eb822020-03-30 20:11:39 +0200602pre_back_up () {
603 for x in $files_to_back_up; do
604 cp -p "$x" "$x$backup_suffix"
605 done
606}
607
Gilles Peskine8f073122018-11-27 15:58:47 +0100608pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100609 failure_count=0 # Number of failed components
610 last_failure_status=0 # Last failure status in this component
611
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100612 # See err_trap
613 previous_failure_status=0
614 previous_failed_command=
615 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100616 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100617
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 start_red=
619 end_color=
620 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100621 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100622 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
623 start_red=$(printf '\033[31m')
624 end_color=$(printf '\033[0m')
625 ;;
626 esac
627 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100628
629 # Keep a summary of failures in a file. We'll print it out at the end.
630 failure_summary_file=$PWD/all-sh-failures-$$.log
631 : >"$failure_summary_file"
632
633 # Whether it makes sense to keep a component going after the specified
634 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200635 # This function normally receives the failing simple command
636 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
637 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200639 # False positives result in running things that can't be expected to
640 # work. False negatives result in things not running after something else
641 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100642 can_keep_going_after_failure () {
643 case "$1" in
644 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200645 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100646 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200647 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
648 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
649 *make*check*) true;;
650 "grep "*) true;;
651 "[ "*) true;;
652 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100653 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100654 esac
655 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100656
657 # This function runs if there is any error in a component.
658 # It must either exit with a nonzero status, or set
659 # last_failure_status to a nonzero value.
660 err_trap () {
661 # Save $? (status of the failing command). This must be the very
662 # first thing, before $? is overridden.
663 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100664 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100665
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100666 if [[ $last_failure_status -eq $previous_failure_status &&
667 "$failed_command" == "$previous_failed_command" &&
668 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
669 then
670 # The same command failed twice in a row, but this time one level
671 # less deep in the function call stack. This happens when the last
672 # command of a function returns a nonzero status, and the function
673 # returns that same status. Ignore the second failure.
674 previous_failure_funcall_depth=${#FUNCNAME[@]}
675 return
676 fi
677 previous_failure_status=$last_failure_status
678 previous_failed_command=$failed_command
679 previous_failure_funcall_depth=${#FUNCNAME[@]}
680
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 text="$current_section: $failed_command -> $last_failure_status"
682 echo "${start_red}^^^^$text^^^^${end_color}" >&2
683 echo "$text" >>"$failure_summary_file"
684
685 # If the command is fatal (configure or build command), stop this
686 # component. Otherwise (test command) keep the component running
687 # (run more tests from the same build).
688 if ! can_keep_going_after_failure "$failed_command"; then
689 exit $last_failure_status
690 fi
691 }
692
Gilles Peskine7c652162017-12-11 00:01:40 +0100693 final_report () {
694 if [ $failure_count -gt 0 ]; then
695 echo
696 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100697 echo "${start_red}FAILED: $failure_count components${end_color}"
698 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
700 elif [ -z "${1-}" ]; then
701 echo "SUCCESS :)"
702 fi
703 if [ -n "${1-}" ]; then
704 echo "Killed by SIG$1."
705 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 rm -f "$failure_summary_file"
707 if [ $failure_count -gt 0 ]; then
708 exit 1
709 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100710 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100711}
712
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200713# record_status() and if_build_succeeded() are kept temporarily for backward
714# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100715record_status () {
716 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100717}
Gilles Peskine7c652162017-12-11 00:01:40 +0100718if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
721
Gilles Peskinea681c592020-03-28 21:27:40 +0100722# '! true' does not trigger the ERR trap. Arrange to trigger it, with
723# a reasonably informative error message (not just "$@").
724not () {
725 if "$@"; then
726 report_failed_command="! $*"
727 false
728 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200729 fi
730}
731
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200732pre_prepare_outcome_file () {
733 case "$MBEDTLS_TEST_OUTCOME_FILE" in
734 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
735 esac
736 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
737 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
738 fi
739}
740
Gilles Peskine8f073122018-11-27 15:58:47 +0100741pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200742 if [ $QUIET -eq 1 ]; then
743 return
744 fi
745
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 msg "info: $0 configuration"
747 echo "MEMORY: $MEMORY"
748 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200749 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100750 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100751 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
754 echo "GNUTLS_CLI: $GNUTLS_CLI"
755 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
757 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
758}
Andres AG7770ea82016-10-10 15:46:20 +0100759
Andres AGd9eba4b2016-08-26 14:42:14 +0100760# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100761pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000762 # Build the list of variables to pass to output_env.sh.
763 set env
SimonB2e23c822016-04-16 21:54:39 +0100764
Gilles Peskine87964262019-01-06 22:40:00 +0000765 case " $RUN_COMPONENTS " in
766 # Require OpenSSL and GnuTLS if running any tests (as opposed to
767 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
768 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100769 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000770 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
771 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100772 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000773 export GNUTLS_CLI="$GNUTLS_CLI"
774 export GNUTLS_SERV="$GNUTLS_SERV"
775 # Avoid passing --seed flag in every call to ssl-opt.sh
776 if [ -n "${SEED-}" ]; then
777 export SEED
778 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200779 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000780 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200781 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
782 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000783 ;;
784 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
787 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200791 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000792 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
796 esac
797
798 case " $RUN_COMPONENTS " in
799 *" test_zeroize "*) check_tools "gdb";;
800 esac
801
802 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000803 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000804 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
805 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200806 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
808 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
810 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
811 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000812 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000813
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200814 # past this point, no call to check_tool, only printing output
815 if [ $QUIET -eq 1 ]; then
816 return
817 fi
818
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000819 msg "info: output_env.sh"
820 case $RUN_COMPONENTS in
821 *_armcc*)
822 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
823 *) set "$@" RUN_ARMCC=0;;
824 esac
825 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100826}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100827
Gilles Peskine1570b592021-04-22 01:10:12 +0200828pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200829 # since make doesn't have proper dependencies, remove any possibly outdate
830 # file that might be around before generating fresh ones
831 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200832 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200833 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200834 else
835 make generated_files
836 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200837}
838
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000839clang_version() {
840 if command -v clang > /dev/null ; then
841 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
842 else
843 echo 0 # report version 0 for "no clang"
844 fi
845}
846
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200847################################################################
848#### Helpers for components using libtestdriver1
849################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100850
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200851# How to use libtestdriver1
852# -------------------------
853#
854# 1. Define the list algorithms and key types to accelerate,
855# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
856# Examples:
857# - loc_accel_list="ALG_JPAKE"
858# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200859# 2. Make configurations changes for the driver and/or main libraries.
860# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
861# can be either "default" to start with the default config, or a name
862# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200863# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200864# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
865# These changes affect both the driver and the main libraries.
866# (Note: they need to have the same set of PSA_WANT symbols, as that
867# determines the ABI between them.)
868# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
869# main libraries. Typically, you want to disable the module(s) that are
870# being accelerated. You may need to also disable modules that depend
871# on them or options that are not supported with drivers.
872# 2d. On top of psa/crypto_config.h, the driver library uses its own config
873# file: tests/include/test/drivers/config_test_driver.h. You usually
874# don't need to edit it: using loc_extra_list (see below) is preferred.
875# However, when there's no PSA symbol for what you want to enable,
876# calling scripts/config.py on this file remains the only option.
877# 3. Build the driver library, then the main libraries, test, and programs.
878# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
879# need to enable more algorithms here, typically hash algorithms when
880# accelerating some signature algorithms (ECDSA, RSAv2). This is done
881# by passing a 2nd argument listing the extra algorithms.
882# Example:
883# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
884# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800885# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200886# additional arguments will be passed to make: this can be useful if
887# you don't want to build everything when iterating during development.
888# Example:
889# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
890# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200891
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200892# Adjust the configuration - for both libtestdriver1 and main library,
893# as they should have the same PSA_WANT macros.
894helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200895 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200896 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200897 if [ "$base_config" != "default" ]; then
898 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 fi
900
901 # Enable PSA-based config (necessary to use drivers)
902 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
903
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200904 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
905 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
906 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000907
908 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
909 # otherwise we will end up running multithreaded tests without mutexes to protect them.
910 if scripts/config.py get MBEDTLS_THREADING_C; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
912 fi
913
914 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
915 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
916 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200917}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100918
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100919# Build the drivers library libtestdriver1.a (with ASan).
920#
921# Parameters:
922# 1. a space-separated list of things to accelerate;
923# 2. optional: a space-separate list of things to also support.
924# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
925helper_libtestdriver1_make_drivers() {
926 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
927 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
928}
929
930# Build the main libraries, programs and tests,
931# linking to the drivers library (with ASan).
932#
933# Parameters:
934# 1. a space-separated list of things to accelerate;
935# *. remaining arguments if any are passed directly to make
936# (examples: lib, -C tests test_suite_xxx, etc.)
937# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
938helper_libtestdriver1_make_main() {
939 loc_accel_list=$1
940 shift
941
942 # we need flags both with and without the LIBTESTDRIVER1_ prefix
943 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
944 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
945 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" "$@"
946}
947
Valerio Settid1b6ef12024-05-07 16:00:21 +0200948# $1: target which can be "client" or "server"
949helper_crypto_client_build() {
950 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200951 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200952 TARGET_LIB=libpsa$TARGET
953
Valerio Settid1b6ef12024-05-07 16:00:21 +0200954 if [ "$TARGET" == "client" ]; then
955 scripts/config.py full
956 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
957 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
958 # Dynamic secure element support is a deprecated feature and it is not
959 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
960 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
961 # Disable potentially problematic features
962 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
963 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
964 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
965 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
966 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
967 else
968 scripts/config.py crypto_full
969 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
970 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200971 fi
972
Valerio Settif57afd52024-05-14 10:39:20 +0200973 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200974
Valerio Settif57afd52024-05-14 10:39:20 +0200975 # cleanup() will restore some backed-up files which include $CONFIG_H and
976 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
977 # point.
978 cleanup
Valerio Settid1b6ef12024-05-07 16:00:21 +0200979}
980
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100981################################################################
982#### Configuration helpers
983################################################################
984
Valerio Settib2fd6732023-08-15 17:10:47 +0200985# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200986# The function optionally accepts 1 parameter: a space-separated list of the
987# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200988helper_disable_builtin_curves() {
989 allowed_list="${1:-}"
990 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
991
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200992 for curve in $allowed_list; do
993 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200994 done
995}
996
997# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
998# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
999# in the following helpers.
1000helper_get_psa_curve_list () {
1001 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001002 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1003 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001004 done
1005
1006 echo "$loc_list"
1007}
1008
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001009# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1010# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1011# in the following helpers.
1012helper_get_psa_dh_group_list () {
1013 loc_list=""
1014 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1015 loc_list="$loc_list $item"
1016 done
1017
1018 echo "$loc_list"
1019}
1020
Valerio Settib2fd6732023-08-15 17:10:47 +02001021# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001022# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001023# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001024helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001025 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001026 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001027 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 +02001028 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1029 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001030 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1031 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001032 fi
1033 done
1034
1035 echo "$loc_list"
1036}
1037
Gilles Peskine192c72f2017-12-21 15:59:21 +01001038################################################################
1039#### Basic checks
1040################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001041
1042#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001043# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001044#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001045# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001047# 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 +02001048# time, so start with a GCC build).
1049# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001050#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001051# Indicative running times are given for reference.
1052
Gilles Peskine8f073122018-11-27 15:58:47 +01001053component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001054 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001055 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001056}
Janos Follathb72c6782016-07-19 14:54:17 +01001057
Gilles Peskine67debb62021-05-18 16:09:50 +02001058component_check_generated_files () {
1059 msg "Check: check-generated-files, files generated with make" # 2s
1060 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001061 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001062
1063 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001064 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001065 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001066 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001067
1068 msg "Check: check-generated-files -u, files absent" # 2s
1069 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001070 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001071 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001072 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001073
1074 # This component ends with the generated files present in the source tree.
1075 # This is necessary for subsequent components!
1076}
1077
Gilles Peskine8f073122018-11-27 15:58:47 +01001078component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001079 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001080 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001081}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001082
Gilles Peskine8f073122018-11-27 15:58:47 +01001083component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001084 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001085 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001086}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001087
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001088component_check_changelog () {
1089 msg "Check: changelog entries" # < 1s
1090 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001091 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001092 if [ -e ChangeLog.new ]; then
1093 # Show the diff for information. It isn't an error if the diff is
1094 # non-empty.
1095 diff -u ChangeLog ChangeLog.new || true
1096 rm ChangeLog.new
1097 fi
1098}
1099
Gilles Peskine8f073122018-11-27 15:58:47 +01001100component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001101 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001102 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001103}
Darryl Greena07039c2018-03-13 16:48:16 +00001104
Gilles Peskine895868b2019-09-19 21:30:05 +02001105component_check_test_cases () {
1106 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001107 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001108 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001109 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001110 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001111 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001112 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001113 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001114}
1115
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001116component_check_test_dependencies () {
1117 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001118 # The purpose of this component is to catch unjustified dependencies on
1119 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1120 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1121 # MBEDTLS_PSA_xxx).
1122 #
1123 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1124 # this component is meant to catch. However a few of them are justified,
1125 # mostly by the absence of a PSA equivalent, so this component includes a
1126 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001127
1128 found="check-test-deps-found-$$"
1129 expected="check-test-deps-expected-$$"
1130
1131 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001132 grep 'depends_on' \
1133 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001134 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001135 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001136 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001137
Yanray Wang18040ed2023-11-23 21:29:56 +08001138 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001139 rm -f $expected
1140 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1141 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001142 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1143 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001144 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1145 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001146 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1147 # the test code and that's probably the most convenient way of achieving
1148 # the test's goal.
1149 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1150 # No PSA equivalent - we should probably have one in the future.
1151 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1152 # No PSA equivalent - needed by some init tests
1153 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001154 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001155 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001156
1157 # Compare reality with expectation.
1158 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001159 #
1160 # The output should be empty. When it's not:
1161 # - Each '+' line is a macro that was found but not expected. You want to
1162 # find where that macro occurs, and either replace it with PSA macros, or
1163 # add it to the exceptions list above with a justification.
1164 # - Each '-' line is a macro that was expected but not found; it means the
1165 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001166 diff -U0 $expected $found
1167
1168 rm $found $expected
1169}
1170
Gilles Peskine8f073122018-11-27 15:58:47 +01001171component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001172 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001173 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001174}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001175
Gilles Peskine192c72f2017-12-21 15:59:21 +01001176
Gilles Peskine636c26a2020-03-04 20:46:15 +01001177
Gilles Peskine192c72f2017-12-21 15:59:21 +01001178################################################################
1179#### Build and test many configurations and targets
1180################################################################
1181
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001182component_test_default_out_of_box () {
1183 msg "build: make, default config (out-of-box)" # ~1min
1184 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001185 # Disable fancy stuff
1186 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001187
1188 msg "test: main suites make, default config (out-of-box)" # ~10s
1189 make test
1190
1191 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001192 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001193
1194 msg "program demos: make, default config (out-of-box)" # ~10s
1195 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001196}
1197
Gilles Peskine8f073122018-11-27 15:58:47 +01001198component_test_default_cmake_gcc_asan () {
1199 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001200 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1201 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001202
Gilles Peskine8f073122018-11-27 15:58:47 +01001203 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1204 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001205
Gilles Peskine82b27272019-06-14 18:27:03 +02001206 msg "program demos (ASan build)" # ~10s
1207 tests/scripts/run_demos.py
1208
Gilles Peskine97bea012020-04-23 23:37:45 +02001209 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001210 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001211
Gilles Peskine6848d172023-11-02 19:58:03 +01001212 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001213 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001214
Gilles Peskine8f073122018-11-27 15:58:47 +01001215 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001216 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001217
Gilles Peskine8f073122018-11-27 15:58:47 +01001218 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001219 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001220
1221 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001222 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001223}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001224
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001225component_test_default_cmake_gcc_asan_new_bignum () {
1226 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001227 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001228 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001229 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001230
1231 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1232 make test
1233
1234 msg "test: selftest (ASan build)" # ~ 10s
1235 programs/test/selftest
1236
1237 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1238 tests/ssl-opt.sh
1239
1240 msg "test: compat.sh (ASan build)" # ~ 6 min
1241 tests/compat.sh
1242
1243 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1244 tests/context-info.sh
1245}
1246
Hanno Becker01635512019-02-26 14:27:09 +00001247component_test_full_cmake_gcc_asan () {
1248 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001249 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001250 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1251 make
1252
1253 msg "test: main suites (inc. selftests) (full config, ASan build)"
1254 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001255
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001256 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001257 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001258
Gilles Peskine636c26a2020-03-04 20:46:15 +01001259 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001260 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001261
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001262 # Note: the next two invocations cover all compat.sh test cases.
1263 # We should use the same here and in basic-build-test.sh.
1264 msg "test: compat.sh: default version (full config, ASan build)"
1265 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001266
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001267 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1268 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001269
1270 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001271 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001272}
1273
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001274
1275component_test_full_cmake_gcc_asan_new_bignum () {
1276 msg "build: full config, cmake, gcc, ASan"
1277 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001278 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001279 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001280 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001281
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001282 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001283 make test
1284
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001285 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001286 programs/test/selftest
1287
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001288 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001289 tests/ssl-opt.sh
1290
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001291 # Note: the next two invocations cover all compat.sh test cases.
1292 # We should use the same here and in basic-build-test.sh.
1293 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1294 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001295
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001296 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1297 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001298
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001299 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001300 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001301}
1302
Ronald Cronc3623db2020-10-29 10:51:32 +01001303component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001304 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001305 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001306 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1307 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1308 make
1309
1310 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1311 make test
1312}
1313
David Horstmann4a48bec2024-03-13 15:42:31 +00001314component_test_psa_assume_exclusive_buffers () {
1315 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001316 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001317 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001318 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1319 make
1320
David Horstmann4a48bec2024-03-13 15:42:31 +00001321 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001322 make test
1323}
1324
Gilles Peskinea3548672021-06-17 11:37:52 +02001325# check_renamed_symbols HEADER LIB
1326# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1327# name is LIB.
1328check_renamed_symbols () {
1329 ! nm "$2" | sed 's/.* //' |
1330 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1331}
1332
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001333component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001334 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001335 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001336 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1337 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1338 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1339 # We can only compile, not link, since our test and sample programs
1340 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1341 # is active.
1342 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001343
1344 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1345 # version is not present.
1346 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001347 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001348}
1349
Valerio Setti63097752024-03-12 13:18:13 +01001350# Get a list of library-wise undefined symbols and ensure that they only
1351# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1352# This function is a common helper used by both:
1353# - component_test_default_psa_crypto_client_without_crypto_provider
1354# - component_build_full_psa_crypto_client_without_crypto_provider.
1355common_check_mbedtls_missing_symbols() {
1356 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1357 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1358 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1359 not grep mbedtls_ linking_errors.txt
1360
1361 rm sym_def.txt sym_undef.txt linking_errors.txt
1362}
1363
1364component_test_default_psa_crypto_client_without_crypto_provider () {
1365 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1366
Ronald Cron336678b2021-01-28 17:54:24 +01001367 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1368 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001369 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001370 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001371 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001372 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001373
Ronald Cron336678b2021-01-28 17:54:24 +01001374 make
1375
Valerio Setti63097752024-03-12 13:18:13 +01001376 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1377 common_check_mbedtls_missing_symbols
1378
1379 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001380 make test
1381}
1382
Valerio Setti63097752024-03-12 13:18:13 +01001383component_build_full_psa_crypto_client_without_crypto_provider () {
1384 msg "build: full config - PSA_CRYPTO_C"
1385
1386 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1387 scripts/config.py full
1388
1389 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1390 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1391 # Dynamic secure element support is a deprecated feature and it is not
1392 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1393 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1394
1395 # Since there is no crypto provider in this build it is not possible to
1396 # build all the test executables and progrems due to missing PSA functions
1397 # at link time. Therefore we will just build libraries and we'll check
1398 # that symbols of interest are there.
1399 make lib
1400
1401 msg "check missing symbols: full config - PSA_CRYPTO_C"
1402
1403 common_check_mbedtls_missing_symbols
1404
1405 # Ensure that desired functions are included into the build (extend the
1406 # following list as required).
1407 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1408 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1409 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1410}
1411
Ryan Everettdaa322a2024-04-18 16:48:55 +01001412component_test_no_rsa_key_pair_generation() {
1413 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001414 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001415 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001416 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001417 make
1418
Ryan Everettdaa322a2024-04-18 16:48:55 +01001419 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001420 make test
1421}
1422
Gilles Peskine782f4112018-11-27 16:11:09 +01001423component_test_ref_configs () {
1424 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001425 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1426 # want to re-generate generated files that depend on it, quite correctly.
1427 # However this doesn't work as the generation script expects a specific
1428 # format for mbedtls_config.h, which the other files don't follow. Also,
1429 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001430 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001431 # whether they're on or off. So, disable cmake's (over-sensitive here)
1432 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001433 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001434 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001435 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001436}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001437
Gilles Peskine8f073122018-11-27 15:58:47 +01001438component_test_no_renegotiation () {
1439 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001440 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001441 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001442 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001443
Gilles Peskine8f073122018-11-27 15:58:47 +01001444 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1445 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001446
Gilles Peskine8f073122018-11-27 15:58:47 +01001447 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001448 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001449}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001450
Gilles Peskine636c26a2020-03-04 20:46:15 +01001451component_test_no_pem_no_fs () {
1452 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1453 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1454 scripts/config.py unset MBEDTLS_FS_IO
1455 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1456 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001457 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001458 make
1459
1460 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1461 make test
1462
1463 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001464 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001465}
1466
Gilles Peskine8f073122018-11-27 15:58:47 +01001467component_test_rsa_no_crt () {
1468 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001469 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001470 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001471 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001472
Gilles Peskine8f073122018-11-27 15:58:47 +01001473 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1474 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001477 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001478
Gilles Peskine8f073122018-11-27 15:58:47 +01001479 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001480 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001481
1482 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001483 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001484}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001485
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001486component_test_no_ctr_drbg_classic () {
1487 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001488 scripts/config.py full
1489 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001490 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001491 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001492
Dave Rodgman17127e92023-12-14 16:42:48 +00001493 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001494 make
1495
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001496 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497 make test
1498
Gilles Peskineba749042021-01-13 20:02:03 +01001499 # In this configuration, the TLS test programs use HMAC_DRBG.
1500 # The SSL tests are slow, so run a small subset, just enough to get
1501 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001503 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001504
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001505 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001506 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001507}
1508
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001509component_test_no_ctr_drbg_use_psa () {
1510 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001511 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1513 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001514
Dave Rodgman17127e92023-12-14 16:42:48 +00001515 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001516 make
1517
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001518 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1519 make test
1520
1521 # In this configuration, the TLS test programs use HMAC_DRBG.
1522 # The SSL tests are slow, so run a small subset, just enough to get
1523 # confidence that the SSL code copes with HMAC_DRBG.
1524 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001525 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001526
1527 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001528 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001529}
1530
1531component_test_no_hmac_drbg_classic () {
1532 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1533 scripts/config.py full
1534 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1535 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1536 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001537 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001538
Dave Rodgman17127e92023-12-14 16:42:48 +00001539 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540 make
1541
1542 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001543 make test
1544
Gilles Peskinea2224342020-11-19 22:14:34 +01001545 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1546 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1547 # instead.
1548 # Test SSL with non-deterministic ECDSA. Only test features that
1549 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001550 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001551 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001552
1553 # To save time, only test one protocol version, since this part of
1554 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001556 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001557}
1558
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001559component_test_no_hmac_drbg_use_psa () {
1560 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1561 scripts/config.py full
1562 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1563 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1564 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1565
Dave Rodgman17127e92023-12-14 16:42:48 +00001566 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001567 make
1568
1569 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1570 make test
1571
1572 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1573 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1574 # instead.
1575 # Test SSL with non-deterministic ECDSA. Only test features that
1576 # might be affected by how ECDSA signature is performed.
1577 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001578 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001579
1580 # To save time, only test one protocol version, since this part of
1581 # the protocol is identical in (D)TLS up to 1.2.
1582 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001583 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584}
1585
1586component_test_psa_external_rng_no_drbg_classic () {
1587 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1588 scripts/config.py full
1589 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001590 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001591 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001592 scripts/config.py unset MBEDTLS_ENTROPY_C
1593 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1594 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001595 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1596 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1597 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001598 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1599 # the SSL test programs don't have an RNG and can't work. Explicitly
1600 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001601 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001602
1603 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1604 make test
1605
Gilles Peskine8eb29432021-02-03 20:07:11 +01001606 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001607 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001608}
1609
1610component_test_psa_external_rng_no_drbg_use_psa () {
1611 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001612 scripts/config.py full
1613 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001614 scripts/config.py unset MBEDTLS_ENTROPY_C
1615 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1616 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001617 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1618 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1619 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001620 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001621
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001622 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001623 make test
1624
Gilles Peskine8eb29432021-02-03 20:07:11 +01001625 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001626 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001627}
1628
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001629component_test_psa_external_rng_use_psa_crypto () {
1630 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1631 scripts/config.py full
1632 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1633 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1634 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001635 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001636
1637 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1638 make test
1639
1640 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1641 tests/ssl-opt.sh -f 'Default\|opaque'
1642}
1643
Gilles Peskine801c4332023-04-28 21:04:28 +02001644component_test_psa_inject_entropy () {
1645 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1646 scripts/config.py full
1647 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1648 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1649 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1650 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1651 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1652 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001653 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 +02001654
1655 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1656 make test
1657}
1658
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001659component_test_sw_inet_pton () {
1660 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1661
1662 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1663 scripts/config.py set MBEDTLS_TEST_HOOKS
1664 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1665
1666 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1667 make test
1668}
1669
Valerio Settia41654d2024-02-08 10:33:11 +01001670component_full_no_pkparse_pkwrite() {
1671 msg "build: full without pkparse and pkwrite"
1672
1673 scripts/config.py crypto_full
1674 scripts/config.py unset MBEDTLS_PK_PARSE_C
1675 scripts/config.py unset MBEDTLS_PK_WRITE_C
1676
Valerio Settia41654d2024-02-08 10:33:11 +01001677 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1678
1679 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1680 not grep mbedtls_pk_parse_key library/pkparse.o
1681 not grep mbedtls_pk_write_key_der library/pkwrite.o
1682
1683 msg "test: full without pkparse and pkwrite"
1684 make test
1685}
1686
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001687component_test_crypto_full_md_light_only () {
1688 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001689 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001690 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001691 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001692 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001693 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001694 scripts/config.py unset MBEDTLS_HKDF_C
1695 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001696 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001697 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001698 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001699 # Disable things that would auto-enable MD_C
1700 scripts/config.py unset MBEDTLS_PKCS5_C
1701
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001702 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1703 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001704 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001705
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001706 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001707 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001708 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001709
1710 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001711 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001712}
1713
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001714component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001715 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001716 scripts/config.py full
1717 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001718 # Don't pull in cipher via PSA mechanisms
1719 # (currently ignored anyway because we completely disable PSA)
1720 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001721 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001722 scripts/config.py unset MBEDTLS_CMAC_C
1723 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001724 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001725 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001726 scripts/config.py unset MBEDTLS_SSL_TLS_C
1727 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001728 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001729 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1730 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001731 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001732 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001733 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001734
Valerio Settidf17a102023-10-23 14:14:19 +02001735 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001736 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001737}
1738
Valerio Setti7e710e82023-08-25 09:14:15 +02001739# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001740# - component_test_full_no_cipher_with_psa_crypto
1741# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001742# It accepts 2 input parameters:
1743# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1744# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001745common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001746 USE_CRYPTO_CONFIG="$1"
1747 COMPONENT_DESCRIPTION="$2"
1748
1749 msg "build: $COMPONENT_DESCRIPTION"
1750
1751 scripts/config.py full
1752 scripts/config.py unset MBEDTLS_CIPHER_C
1753
1754 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001755 # The built-in implementation of the following algs/key-types depends
1756 # on CIPHER_C so we disable them.
1757 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1758 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001759 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001760 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1761 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1762 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1763 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1764 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1765 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1766 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Crona33a8242024-05-15 18:31:17 +02001767 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001768 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001769 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001770 else
1771 # Don't pull in cipher via PSA mechanisms
1772 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001773 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1774 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1775 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001776 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001777 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001778 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001779 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001780
Gilles Peskine21570cf2023-12-22 11:49:50 +01001781 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001782
Valerio Setti7e710e82023-08-25 09:14:15 +02001783 # Ensure that CIPHER_C was not re-enabled
1784 not grep mbedtls_cipher_init library/cipher.o
1785
1786 msg "test: $COMPONENT_DESCRIPTION"
1787 make test
1788}
1789
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001790component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001791 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001792}
1793
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001794component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001795 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001796}
1797
Valerio Settibdfecb62023-11-07 15:37:20 +01001798component_test_full_no_ccm() {
1799 msg "build: full no PSA_WANT_ALG_CCM"
1800
1801 # Full config enables:
1802 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1803 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1804 scripts/config.py full
1805
1806 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1807 # enabled, but not used from TLS since USE_PSA is set.
1808 # This is helpful to ensure that TLS tests below have proper dependencies.
1809 #
1810 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1811 # PSA_WANT_ALG_CCM to be re-enabled.
1812 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1813
Gilles Peskine21570cf2023-12-22 11:49:50 +01001814 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001815
1816 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001817 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001818}
1819
1820component_test_full_no_ccm_star_no_tag() {
1821 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1822
1823 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1824 scripts/config.py full
1825
1826 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1827 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1828 # This basically disables all unauthenticated ciphers on the PSA side, while
1829 # keeping AEADs enabled.
1830 #
1831 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1832 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1834 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1835 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1836 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1840 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1841
Gilles Peskine21570cf2023-12-22 11:49:50 +01001842 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001843
1844 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001845 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001846
1847 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001848 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001849}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001850
Valerio Settie1655b82023-01-03 15:35:25 +01001851component_test_full_no_bignum () {
1852 msg "build: full minus bignum"
1853 scripts/config.py full
1854 scripts/config.py unset MBEDTLS_BIGNUM_C
1855 # Direct dependencies of bignum
1856 scripts/config.py unset MBEDTLS_ECP_C
1857 scripts/config.py unset MBEDTLS_RSA_C
1858 scripts/config.py unset MBEDTLS_DHM_C
1859 # Direct dependencies of ECP
1860 scripts/config.py unset MBEDTLS_ECDH_C
1861 scripts/config.py unset MBEDTLS_ECDSA_C
1862 scripts/config.py unset MBEDTLS_ECJPAKE_C
1863 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001864 # Disable what auto-enables ECP_LIGHT
1865 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1866 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001867 # Indirect dependencies of ECP
1868 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1869 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1870 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1871 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1872 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1873 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1874 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1875 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1876 # Direct dependencies of DHM
1877 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1878 # Direct dependencies of RSA
1879 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1880 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1881 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1882 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1883 # PK and its dependencies
1884 scripts/config.py unset MBEDTLS_PK_C
1885 scripts/config.py unset MBEDTLS_PK_PARSE_C
1886 scripts/config.py unset MBEDTLS_PK_WRITE_C
1887 scripts/config.py unset MBEDTLS_X509_USE_C
1888 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1889 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1890 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1891 scripts/config.py unset MBEDTLS_X509_CREATE_C
1892 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1893 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1894 scripts/config.py unset MBEDTLS_PKCS7_C
1895 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1896 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1897 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1898
Gilles Peskine21570cf2023-12-22 11:49:50 +01001899 make
Valerio Settie1655b82023-01-03 15:35:25 +01001900
1901 msg "test: full minus bignum"
1902 make test
1903}
1904
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001905component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001906 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001907
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001908 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001909 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001910 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001911 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001912 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001913 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1914 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001915 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001916 scripts/config.py unset MBEDTLS_GCM_C
1917 scripts/config.py unset MBEDTLS_CCM_C
1918 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001919 #Disable TLS 1.3 (as no AEAD)
1920 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001921 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1922 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1923 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001924 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney67338c02024-05-09 15:21:14 +01001925 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001926 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001927 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001928 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001929 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1930 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001931 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001932 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001933 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001934
Przemek Stekiel9550c052022-09-28 09:51:55 +02001935 make
1936
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001937 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001938 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001939
1940 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001941}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001942
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001943component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001944 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001945
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001946 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001947 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001948 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001949 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001950 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001951 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1952 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001953 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001954 scripts/config.py unset MBEDTLS_GCM_C
1955 scripts/config.py unset MBEDTLS_CCM_C
1956 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001957 #Disable TLS 1.3 (as no AEAD)
1958 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001959 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney62586212024-04-26 17:01:16 +01001960 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001961 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001962 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001963 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001964 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001965 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001966 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001967 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001968
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001969 make
1970
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001971 msg "test: default with only CBC-legacy cipher use psa"
1972 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001973
1974 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1975 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001976}
1977
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001978component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001979 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001980
1981 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001982 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001983 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001984 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001985 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001986 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1987 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001988 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001989 scripts/config.py unset MBEDTLS_GCM_C
1990 scripts/config.py unset MBEDTLS_CCM_C
1991 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001992 #Disable TLS 1.3 (as no AEAD)
1993 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001994 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001995 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001996 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1997 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1998 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001999 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002000 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002001 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002002 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002003
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002004 make
2005
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002006 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002007 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002008
2009 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2010 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002011}
2012
Valerio Setti9f0ec532022-11-08 13:03:24 +01002013# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2014# that we could use for interop testing. However, we now have sort of two
2015# implementations ourselves: one using PSA, the other not. At least test that
2016# these two interoperate with each other.
2017component_test_tls1_2_ecjpake_compatibility() {
2018 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2019 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002020 # Explicitly make lib first to avoid a race condition:
2021 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2022 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002023 make -C programs ssl/ssl_server2 ssl/ssl_client2
2024 cp programs/ssl/ssl_server2 s2_no_use_psa
2025 cp programs/ssl/ssl_client2 c2_no_use_psa
2026
2027 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2028 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2029 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002030 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002031 make -C programs ssl/ssl_server2 ssl/ssl_client2
2032 make -C programs test/udp_proxy test/query_compile_time_config
2033
Valerio Setti70e02902022-12-02 16:21:56 +01002034 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2035 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2036 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2037 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2038 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2039 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2040 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2041 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 +01002042
2043 rm s2_no_use_psa c2_no_use_psa
2044}
2045
Gilles Peskine636c26a2020-03-04 20:46:15 +01002046component_test_everest () {
2047 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2048 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2049 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2050 make
2051
2052 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2053 make test
2054
Gilles Peskine6848d172023-11-02 19:58:03 +01002055 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002056 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002057
Gilles Peskine636c26a2020-03-04 20:46:15 +01002058 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2059 tests/ssl-opt.sh -f ECDH
2060
2061 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2062 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002063 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002064}
2065
Gilles Peskined3beca92020-07-03 00:15:37 +02002066component_test_everest_curve25519_only () {
2067 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002068 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02002069 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2070 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002071 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
2072 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
2073 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02002074 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2075 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002076 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002077 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
2078
Gilles Peskined3beca92020-07-03 00:15:37 +02002079 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002080 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002081 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
2082 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02002083
Dave Rodgman17127e92023-12-14 16:42:48 +00002084 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002085
2086 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2087 make test
2088}
2089
Gilles Peskine8f073122018-11-27 15:58:47 +01002090component_test_small_ssl_out_content_len () {
2091 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002092 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2093 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002094 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002095 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002096
Gilles Peskine8f073122018-11-27 15:58:47 +01002097 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002098 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002099}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002100
Gilles Peskine8f073122018-11-27 15:58:47 +01002101component_test_small_ssl_in_content_len () {
2102 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002103 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2104 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002105 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002106 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002107
Gilles Peskine8f073122018-11-27 15:58:47 +01002108 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002109 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002110}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002111
Gilles Peskine8f073122018-11-27 15:58:47 +01002112component_test_small_ssl_dtls_max_buffering () {
2113 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002114 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002115 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002116 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002117
Gilles Peskine8f073122018-11-27 15:58:47 +01002118 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002119 tests/ssl-opt.sh -f "DTLS reordering: Buffer out-of-order hs msg before reassembling next, free buffered msg"
Gilles Peskine8f073122018-11-27 15:58:47 +01002120}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002121
Gilles Peskine8f073122018-11-27 15:58:47 +01002122component_test_small_mbedtls_ssl_dtls_max_buffering () {
2123 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002124 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002125 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002126 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002127
Gilles Peskine8f073122018-11-27 15:58:47 +01002128 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002129 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002130}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002131
Gilles Peskine75cc7712019-09-06 19:47:17 +02002132component_test_psa_collect_statuses () {
2133 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002134 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002135 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002136 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002137 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002138 rm -f tests/statuses.log
2139}
2140
Gilles Peskine8f073122018-11-27 15:58:47 +01002141component_test_full_cmake_clang () {
2142 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002143 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002144 CC=clang CXX=clang cmake -D CMAKE_BUILD_TYPE:String=Release -D ENABLE_TESTING=On -D TEST_CPP=1 .
Gilles Peskine8f073122018-11-27 15:58:47 +01002145 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002146
k-stachowiak0291cb72019-06-26 15:52:12 +02002147 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002148 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002149
Gilles Peskineda6017c2022-10-30 21:02:40 +01002150 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2151 programs/test/cpp_dummy_build
2152
Gilles Peskine6848d172023-11-02 19:58:03 +01002153 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002154 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002155
Gilles Peskine82b27272019-06-14 18:27:03 +02002156 msg "program demos (full config, clang)" # ~10s
2157 tests/scripts/run_demos.py
2158
k-stachowiak0291cb72019-06-26 15:52:12 +02002159 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002160 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002161
Gilles Peskine8f073122018-11-27 15:58:47 +01002162 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002163 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002164}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002165
Gilles Peskine0c671602022-11-29 16:01:41 +01002166skip_suites_without_constant_flow () {
2167 # Skip the test suites that don't have any constant-flow annotations.
2168 # This will need to be adjusted if we ever start declaring things as
2169 # secret from macros or functions inside tests/include or tests/src.
2170 SKIP_TEST_SUITES=$(
2171 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2172 sed 's/test_suite_//; s/\.function$//' |
2173 tr '\n' ,)
2174 export SKIP_TEST_SUITES
2175}
2176
Dave Rodgman246210e2023-07-31 18:07:44 +01002177skip_all_except_given_suite () {
2178 # Skip all but the given test suite
2179 SKIP_TEST_SUITES=$(
2180 ls -1 tests/suites/test_suite_*.function |
2181 grep -v $1.function |
2182 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2183 tr '\n' ,)
2184 export SKIP_TEST_SUITES
2185}
2186
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002187component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002188 # This tests both (1) accesses to undefined memory, and (2) branches or
2189 # memory access depending on secret values. To distinguish between those:
2190 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2191 # - or alternatively, change the build type to MemSanDbg, which enables
2192 # origin tracking and nicer stack traces (which are useful for debugging
2193 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002194 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2195 scripts/config.py full
2196 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2197 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2198 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2199 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2200 make
2201
2202 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2203 make test
2204}
2205
2206component_test_memsan_constant_flow_psa () {
2207 # This tests both (1) accesses to undefined memory, and (2) branches or
2208 # memory access depending on secret values. To distinguish between those:
2209 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2210 # - or alternatively, change the build type to MemSanDbg, which enables
2211 # origin tracking and nicer stack traces (which are useful for debugging
2212 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002213 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002214 scripts/config.py full
2215 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2216 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2217 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2218 make
2219
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002220 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002221 make test
2222}
2223
Bence Szépkúti0354d042023-12-06 16:14:37 +01002224component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002225 # This tests both (1) everything that valgrind's memcheck usually checks
2226 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2227 # etc.) and (2) branches or memory access depending on secret values,
2228 # which will be reported as uninitialized memory. To distinguish between
2229 # secret and actually uninitialized:
2230 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2231 # - or alternatively, build with debug info and manually run the offending
2232 # test suite with valgrind --track-origins=yes, then check if the origin
2233 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002234 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2235 scripts/config.py full
2236 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2237 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002238 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002239 cmake -D CMAKE_BUILD_TYPE:String=Release .
2240 make
2241
2242 # this only shows a summary of the results (how many of each type)
2243 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002244 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002245 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002246
2247 # Test asm path in constant time module - by default, it will test the plain C
2248 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2249 msg "test: valgrind asm constant_time"
2250 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2251 skip_all_except_given_suite test_suite_constant_time
2252 cmake -D CMAKE_BUILD_TYPE:String=Release .
2253 make clean
2254 make
2255 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002256}
2257
Bence Szépkúti0354d042023-12-06 16:14:37 +01002258component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002259 # This tests both (1) everything that valgrind's memcheck usually checks
2260 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2261 # etc.) and (2) branches or memory access depending on secret values,
2262 # which will be reported as uninitialized memory. To distinguish between
2263 # secret and actually uninitialized:
2264 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2265 # - or alternatively, build with debug info and manually run the offending
2266 # test suite with valgrind --track-origins=yes, then check if the origin
2267 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002268 msg "build: cmake release GCC, full config with constant flow testing"
2269 scripts/config.py full
2270 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002271 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002272 cmake -D CMAKE_BUILD_TYPE:String=Release .
2273 make
2274
2275 # this only shows a summary of the results (how many of each type)
2276 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002277 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002278 make memcheck
2279}
2280
Janos Follath9338cac2023-10-04 18:55:39 +01002281component_test_tsan () {
2282 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002283 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002284 scripts/config.py set MBEDTLS_THREADING_C
2285 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002286 # Self-tests do not currently use multiple threads.
2287 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002288
Ryan6caf84f2024-03-05 13:57:00 +00002289 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2290 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2291
Janos Follath9338cac2023-10-04 18:55:39 +01002292 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2293 make
2294
2295 msg "test: main suites (TSan)"
2296 make test
2297}
2298
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002299component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002300 # Test that removing the deprecated features from the default
2301 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002302 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2303 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002304 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002305
2306 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2307 make test
2308}
2309
2310component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002311 msg "build: make, full_no_deprecated config" # ~ 30s
2312 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002313 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002314
Gilles Peskine30de2e82020-04-20 21:39:22 +02002315 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002316 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002317
2318 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2319 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002320}
2321
Gilles Peskine8386ea22020-04-30 09:07:29 +02002322component_test_full_no_deprecated_deprecated_warning () {
2323 # Test that there is nothing deprecated in "full_no_deprecated".
2324 # A deprecated feature would trigger a warning (made fatal) from
2325 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002326 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2327 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002328 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2329 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002330 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002331
Gilles Peskine30de2e82020-04-20 21:39:22 +02002332 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002333 make test
2334}
2335
Gilles Peskine8386ea22020-04-30 09:07:29 +02002336component_test_full_deprecated_warning () {
2337 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2338 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002339 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002340 scripts/config.py full
2341 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002342 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002343 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2344 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002345 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002346
Gilles Peskine8386ea22020-04-30 09:07:29 +02002347 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2348 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2349 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002350 # Expect warnings from '#warning' directives in check_config.h and
2351 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002352 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 +01002353
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002354 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2355 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002356
2357 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2358 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002359}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002360
Gilles Peskineec541fe2020-01-31 14:24:14 +01002361# Check that the specified libraries exist and are empty.
2362are_empty_libraries () {
2363 nm "$@" >/dev/null 2>/dev/null
2364 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2365}
2366
2367component_build_crypto_default () {
2368 msg "build: make, crypto only"
2369 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002370 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002371 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002372}
2373
2374component_build_crypto_full () {
2375 msg "build: make, crypto only, full config"
2376 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002377 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002378 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002379}
2380
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002381component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002382 msg "build: make, config for PSA crypto service"
2383 scripts/config.py crypto
2384 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2385 # Disable things that are not needed for just cryptography, to
2386 # reach a configuration that would be typical for a PSA cryptography
2387 # service providing all implemented PSA algorithms.
2388 # System stuff
2389 scripts/config.py unset MBEDTLS_ERROR_C
2390 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002391 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002392 # Crypto stuff with no PSA interface
2393 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002394 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002395 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002396 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002397 scripts/config.py unset MBEDTLS_NIST_KW_C
2398 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2399 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2400 scripts/config.py unset MBEDTLS_PKCS12_C
2401 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002402 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2403 # in PSA code to work with RSA keys. We don't require users to set those:
2404 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002405 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002406 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002407 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002408 make CFLAGS='-O1 -Werror' all test
2409 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2410}
2411
Gilles Peskineec541fe2020-01-31 14:24:14 +01002412component_build_crypto_baremetal () {
2413 msg "build: make, crypto only, baremetal config"
2414 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002415 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002416 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002417}
Daniel Axtens446af202020-09-02 21:30:13 +10002418support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002419 support_build_baremetal "$@"
2420}
2421
2422component_build_baremetal () {
2423 msg "build: make, baremetal config"
2424 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002425 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002426}
2427support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002428 # Older Glibc versions include time.h from other headers such as stdlib.h,
2429 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2430 # problem, Ubuntu 18.04 is ok.
2431 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2432}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002433
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002434# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002435component_test_depends_py_cipher_id () {
2436 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002437 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002438}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002439
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002440component_test_depends_py_cipher_chaining () {
2441 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002442 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002443}
2444
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002445component_test_depends_py_cipher_padding () {
2446 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002447 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002448}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002449
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002450component_test_depends_py_curves () {
2451 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002452 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002453}
2454
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002455component_test_depends_py_hashes () {
2456 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002457 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002458}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002459
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002460component_test_depends_py_kex () {
2461 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002462 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002463}
2464
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002465component_test_depends_py_pkalgs () {
2466 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002467 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002468}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002469
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002470# PSA equivalents of the depends.py tests
2471component_test_depends_py_cipher_id_psa () {
2472 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002473 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002474}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002475
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002476component_test_depends_py_cipher_chaining_psa () {
2477 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002478 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002479}
2480
2481component_test_depends_py_cipher_padding_psa () {
2482 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002483 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002484}
2485
2486component_test_depends_py_curves_psa () {
2487 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002488 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002489}
2490
2491component_test_depends_py_hashes_psa () {
2492 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002493 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002494}
2495
2496component_test_depends_py_kex_psa () {
2497 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002498 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002499}
2500
2501component_test_depends_py_pkalgs_psa () {
2502 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002503 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002504}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002505
Valerio Setti6bed64e2024-01-17 15:21:44 +01002506component_test_psa_crypto_config_ffdh_2048_only () {
2507 msg "build: full config - only DH 2048"
2508
2509 scripts/config.py full
2510
2511 # Disable all DH groups other than 2048.
2512 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2513 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2514 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2515 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2516
2517 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2518
2519 msg "test: full config - only DH 2048"
2520 make test
2521
2522 msg "ssl-opt: full config - only DH 2048"
2523 tests/ssl-opt.sh -f "ffdh"
2524}
2525
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002526component_build_no_pk_rsa_alt_support () {
2527 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2528
2529 scripts/config.py full
2530 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2531 scripts/config.py set MBEDTLS_RSA_C
2532 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2533
2534 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002535 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002536}
2537
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002538component_build_module_alt () {
2539 msg "build: MBEDTLS_XXX_ALT" # ~30s
2540 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002541
2542 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002543 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002544 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002545 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002546 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2547 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002548 # You can only have one threading implementation: alt or pthread, not both.
2549 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002550 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2551 # directly and assumes the implementation works with partial groups.
2552 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002553 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2554 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2555 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002556 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2557 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2558 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002559
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002560 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2561 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2562 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002563 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002564
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002565 # We can only compile, not link, since we don't have any implementations
2566 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002567 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002568}
2569
2570component_build_dhm_alt () {
2571 msg "build: MBEDTLS_DHM_ALT" # ~30s
2572 scripts/config.py full
2573 scripts/config.py set MBEDTLS_DHM_ALT
2574 # debug.c currently references mbedtls_dhm_context fields directly.
2575 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002576 # We can only compile, not link, since we don't have any implementations
2577 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002578 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002579}
2580
Gilles Peskine64996c32024-01-23 20:25:47 +01002581component_test_no_psa_crypto_full_cmake_asan() {
2582 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2583 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002584 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002585 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002586 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002587 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002588 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002589 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002590 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002591 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002592 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002593 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002594 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002595 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002596
Gilles Peskine64996c32024-01-23 20:25:47 +01002597 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002598 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002599
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002600 # Note: ssl-opt.sh has some test cases that depend on
2601 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2602 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002603 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002604 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002605
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002606 # Note: the next two invocations cover all compat.sh test cases.
2607 # We should use the same here and in basic-build-test.sh.
2608 msg "test: compat.sh: default version (full minus PSA crypto)"
2609 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002610
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002611 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002612 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002613}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002614
Ronald Cron403c15c2021-09-13 09:38:05 +02002615component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002616 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002617
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002618 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002619 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002620 $(helper_get_psa_key_type_list "ECC") \
2621 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002622
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002623 # Configure
2624 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002625
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002626 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002627 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002628
2629 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002630 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002631
2632 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002633 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2634 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2635
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002636 # Build
2637 # -----
2638
2639 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002640 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2641 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002642
2643 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2644
Valerio Setti3fe105b2023-10-30 11:08:12 +01002645 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002646
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002647 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002648 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002649
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002650 # Run the tests
2651 # -------------
2652
Ronald Cron403c15c2021-09-13 09:38:05 +02002653 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2654 make test
2655}
2656
Valerio Setti44b178c2023-03-22 14:02:57 +01002657component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002658 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002659
2660 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002661 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002662 $(helper_get_psa_key_type_list "ECC") \
2663 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002664
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002665 # Configure
2666 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002667
Ronald Cron46ac0652024-03-18 12:39:04 +01002668 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002669 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002670
Valerio Setti44b178c2023-03-22 14:02:57 +01002671 # Disable the module that's accelerated
2672 scripts/config.py unset MBEDTLS_ECDH_C
2673
2674 # Disable things that depend on it
2675 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2676 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2677 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2678 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2679 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2680
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002681 # Build
2682 # -----
2683
2684 helper_libtestdriver1_make_drivers "$loc_accel_list"
2685
Valerio Setti3fe105b2023-10-30 11:08:12 +01002686 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002687
Valerio Setti44b178c2023-03-22 14:02:57 +01002688 # Make sure this was not re-enabled by accident (additive config)
2689 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002690
2691 # Run the tests
2692 # -------------
2693
Valerio Setti44b178c2023-03-22 14:02:57 +01002694 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002695 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002696}
2697
Przemek Stekieldccb2022023-05-11 10:48:50 +02002698component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002699 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002700
2701 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002702 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002703 $(helper_get_psa_key_type_list "DH") \
2704 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002705
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002706 # Configure
2707 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002708
Przemek Stekiel565353e2023-07-05 11:07:07 +02002709 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002710 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002711
2712 # Disable the module that's accelerated
2713 scripts/config.py unset MBEDTLS_DHM_C
2714
2715 # Disable things that depend on it
2716 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2717 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2718
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002719 # Build
2720 # -----
2721
2722 helper_libtestdriver1_make_drivers "$loc_accel_list"
2723
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002724 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002725
2726 # Make sure this was not re-enabled by accident (additive config)
2727 not grep mbedtls_dhm_ library/dhm.o
2728
2729 # Run the tests
2730 # -------------
2731
Gilles Peskine14302ed2023-07-19 19:30:04 +02002732 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002733 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002734
Gilles Peskine14302ed2023-07-19 19:30:04 +02002735 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002736 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002737}
2738
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002739component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002740 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002741
2742 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002743 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002744
2745 # Disable things that are not supported
2746 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2747 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002748 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002749
Gilles Peskine14302ed2023-07-19 19:30:04 +02002750 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002751 make test
2752
Gilles Peskine14302ed2023-07-19 19:30:04 +02002753 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002754 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002755}
2756
Valerio Setti44b178c2023-03-22 14:02:57 +01002757component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002758 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002759
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002760 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002761 $(helper_get_psa_key_type_list "ECC") \
2762 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002763
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002764 # Configure
2765 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002766
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002767 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002768
2769 # Make built-in fallback not available
2770 scripts/config.py unset MBEDTLS_ECJPAKE_C
2771 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2772
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002773 # Build
2774 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002775
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002776 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002777
Valerio Setti3fe105b2023-10-30 11:08:12 +01002778 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002779
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002780 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002781 not grep mbedtls_ecjpake_init library/ecjpake.o
2782
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002783 # Run the tests
2784 # -------------
2785
Gilles Peskine14302ed2023-07-19 19:30:04 +02002786 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002787 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002788}
2789
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002790component_test_psa_crypto_config_accel_ecc_some_key_types () {
2791 msg "build: full with accelerated EC algs and some key types"
2792
2793 # Algorithms and key types to accelerate
2794 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2795 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2796 ALG_ECDH \
2797 ALG_JPAKE \
2798 KEY_TYPE_ECC_PUBLIC_KEY \
2799 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2800 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002801 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2802 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002803
2804 # Configure
2805 # ---------
2806
2807 # start with config full for maximum coverage (also enables USE_PSA)
2808 helper_libtestdriver1_adjust_config "full"
2809
2810 # Disable modules that are accelerated - some will be re-enabled
2811 scripts/config.py unset MBEDTLS_ECDSA_C
2812 scripts/config.py unset MBEDTLS_ECDH_C
2813 scripts/config.py unset MBEDTLS_ECJPAKE_C
2814 scripts/config.py unset MBEDTLS_ECP_C
2815
2816 # Disable all curves - those that aren't accelerated should be re-enabled
2817 helper_disable_builtin_curves
2818
2819 # Restartable feature is not yet supported by PSA. Once it will in
2820 # the future, the following line could be removed (see issues
2821 # 6061, 6332 and following ones)
2822 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2823
2824 # this is not supported by the driver API yet
2825 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2826
2827 # Build
2828 # -----
2829
2830 # These hashes are needed for some ECDSA signature tests.
2831 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2832 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2833 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2834
Valerio Setti3fe105b2023-10-30 11:08:12 +01002835 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002836
2837 # ECP should be re-enabled but not the others
2838 not grep mbedtls_ecdh_ library/ecdh.o
2839 not grep mbedtls_ecdsa library/ecdsa.o
2840 not grep mbedtls_ecjpake library/ecjpake.o
2841 grep mbedtls_ecp library/ecp.o
2842
2843 # Run the tests
2844 # -------------
2845
2846 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002847 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002848}
2849
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002850# Run tests with only (non-)Weierstrass accelerated
2851# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002852# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2853# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002854common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002855 weierstrass=$1
2856 if [ $weierstrass -eq 1 ]; then
2857 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002858 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002859 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002860 fi
2861
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002862 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002863
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002864 # Note: Curves are handled in a special way by the libtestdriver machinery,
2865 # so we only want to include them in the accel list when building the main
2866 # libraries, hence the use of a separate variable.
2867 # Note: the following loop is a modified version of
2868 # helper_get_psa_curve_list that only keeps Weierstrass families.
2869 loc_weierstrass_list=""
2870 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002871 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2872 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002873 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002874 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002875 ;;
2876 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002877 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002878 ;;
2879 esac
2880 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002881 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002882 loc_curve_list=$loc_weierstrass_list
2883 else
2884 loc_curve_list=$loc_non_weierstrass_list
2885 fi
2886
Valerio Setti3fe105b2023-10-30 11:08:12 +01002887 # Algorithms and key types to accelerate
2888 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2889 ALG_ECDH \
2890 ALG_JPAKE \
2891 $(helper_get_psa_key_type_list "ECC") \
2892 $loc_curve_list"
2893
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002894 # Configure
2895 # ---------
2896
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002897 # Start with config crypto_full and remove PK_C:
2898 # that's what's supported now, see docs/driver-only-builds.md.
2899 helper_libtestdriver1_adjust_config "crypto_full"
2900 scripts/config.py unset MBEDTLS_PK_C
2901 scripts/config.py unset MBEDTLS_PK_PARSE_C
2902 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002903
2904 # Disable modules that are accelerated - some will be re-enabled
2905 scripts/config.py unset MBEDTLS_ECDSA_C
2906 scripts/config.py unset MBEDTLS_ECDH_C
2907 scripts/config.py unset MBEDTLS_ECJPAKE_C
2908 scripts/config.py unset MBEDTLS_ECP_C
2909
2910 # Disable all curves - those that aren't accelerated should be re-enabled
2911 helper_disable_builtin_curves
2912
2913 # Restartable feature is not yet supported by PSA. Once it will in
2914 # the future, the following line could be removed (see issues
2915 # 6061, 6332 and following ones)
2916 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2917
2918 # this is not supported by the driver API yet
2919 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2920
2921 # Build
2922 # -----
2923
2924 # These hashes are needed for some ECDSA signature tests.
2925 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2926 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2927 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2928
Valerio Settiac7a8092023-10-31 12:23:44 +01002929 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002930
2931 # We expect ECDH to be re-enabled for the missing curves
2932 grep mbedtls_ecdh_ library/ecdh.o
2933 # We expect ECP to be re-enabled, however the parts specific to the
2934 # families of curves that are accelerated should be ommited.
2935 # - functions with mxz in the name are specific to Montgomery curves
2936 # - ecp_muladd is specific to Weierstrass curves
2937 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002938 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002939 not grep mbedtls_ecp_muladd library/ecp.o
2940 grep mxz library/ecp.o
2941 else
2942 grep mbedtls_ecp_muladd library/ecp.o
2943 not grep mxz library/ecp.o
2944 fi
2945 # We expect ECDSA and ECJPAKE to be re-enabled only when
2946 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002947 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002948 not grep mbedtls_ecdsa library/ecdsa.o
2949 not grep mbedtls_ecjpake library/ecjpake.o
2950 else
2951 grep mbedtls_ecdsa library/ecdsa.o
2952 grep mbedtls_ecjpake library/ecjpake.o
2953 fi
2954
2955 # Run the tests
2956 # -------------
2957
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002958 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2959 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002960}
2961
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002962component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002963 common_test_psa_crypto_config_accel_ecc_some_curves 1
2964}
2965
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002966component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002967 common_test_psa_crypto_config_accel_ecc_some_curves 0
2968}
2969
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002970# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2971# ECDH, ECDSA) with and without drivers.
2972# The input parameter is a boolean value which indicates:
2973# - 0 keep built-in EC algs,
2974# - 1 exclude built-in EC algs (driver only).
2975#
2976# This is used by the two following components to ensure they always use the
2977# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002978# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2979# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002980# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002981config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002982 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002983 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002984 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002985 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002986 # Disable modules that are accelerated
2987 scripts/config.py unset MBEDTLS_ECDSA_C
2988 scripts/config.py unset MBEDTLS_ECDH_C
2989 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002990 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002991 fi
2992
2993 # Restartable feature is not yet supported by PSA. Once it will in
2994 # the future, the following line could be removed (see issues
2995 # 6061, 6332 and following ones)
2996 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002997}
2998
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002999# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3000component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003001 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003002
3003 # Algorithms and key types to accelerate
3004 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3005 ALG_ECDH \
3006 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003007 $(helper_get_psa_key_type_list "ECC") \
3008 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003009
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003010 # Configure
3011 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003012
3013 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003014 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003015
Valerio Setti0a342c92023-09-01 09:12:31 +02003016 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003017 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3018 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003019
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003020 # Build
3021 # -----
3022
3023 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003024 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3025 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003026 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3027
Valerio Setti3fe105b2023-10-30 11:08:12 +01003028 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003029
3030 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3031 not grep mbedtls_ecdsa_ library/ecdsa.o
3032 not grep mbedtls_ecdh_ library/ecdh.o
3033 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003034 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003035
3036 # Run the tests
3037 # -------------
3038
Gilles Peskine14302ed2023-07-19 19:30:04 +02003039 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003040 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003041
Gilles Peskine14302ed2023-07-19 19:30:04 +02003042 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003043 tests/ssl-opt.sh
3044}
3045
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003046# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3047component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003048 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003049
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003050 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003051
Gilles Peskine21570cf2023-12-22 11:49:50 +01003052 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003053
Gilles Peskine14302ed2023-07-19 19:30:04 +02003054 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003055 make test
3056
Gilles Peskine14302ed2023-07-19 19:30:04 +02003057 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003058 tests/ssl-opt.sh
3059}
3060
Valerio Settie618cb02023-04-12 14:59:16 +02003061# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003062# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3063# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003064# to ensure that both tests use the same underlying configuration when testing
3065# driver's coverage with analyze_outcomes.py.
3066#
3067# This functions accepts 1 boolean parameter as follows:
3068# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3069# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3070# - 0: include built-in implementation of EC algorithms.
3071#
3072# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3073# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003074config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003075 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003076 # start with full config for maximum coverage (also enables USE_PSA)
3077 helper_libtestdriver1_adjust_config "full"
3078
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003079 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003080 # Disable modules that are accelerated
3081 scripts/config.py unset MBEDTLS_ECDSA_C
3082 scripts/config.py unset MBEDTLS_ECDH_C
3083 scripts/config.py unset MBEDTLS_ECJPAKE_C
3084 # Disable ECP module (entirely)
3085 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003086 fi
3087
Valerio Settiaecd32c2023-06-14 10:42:31 +02003088 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3089 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003090 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003091 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003092
Valerio Settie618cb02023-04-12 14:59:16 +02003093 # Restartable feature is not yet supported by PSA. Once it will in
3094 # the future, the following line could be removed (see issues
3095 # 6061, 6332 and following ones)
3096 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003097}
3098
3099# Build and test a configuration where driver accelerates all EC algs while
3100# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3101# side.
3102#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003103# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3104component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003105 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003106
3107 # Algorithms and key types to accelerate
3108 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3109 ALG_ECDH \
3110 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003111 $(helper_get_psa_key_type_list "ECC") \
3112 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003113
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003114 # Configure
3115 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003116
Valerio Settie618cb02023-04-12 14:59:16 +02003117 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003118 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003119 # Disable all the builtin curves. All the required algs are accelerated.
3120 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003121
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003122 # Build
3123 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003124
3125 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003126 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3127 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3128 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003129
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003130 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003131
Valerio Setti3fe105b2023-10-30 11:08:12 +01003132 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003133
3134 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3135 not grep mbedtls_ecdsa_ library/ecdsa.o
3136 not grep mbedtls_ecdh_ library/ecdh.o
3137 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003138 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003139 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003140
3141 # Run the tests
3142 # -------------
3143
Gilles Peskine14302ed2023-07-19 19:30:04 +02003144 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003145 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003146
Gilles Peskine14302ed2023-07-19 19:30:04 +02003147 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003148 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003149}
3150
3151# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003152# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003153# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003154component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003155 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003156
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003157 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003158
Gilles Peskine21570cf2023-12-22 11:49:50 +01003159 make
Valerio Settie618cb02023-04-12 14:59:16 +02003160
Gilles Peskine14302ed2023-07-19 19:30:04 +02003161 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003162 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003163
Gilles Peskine14302ed2023-07-19 19:30:04 +02003164 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003165 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003166}
3167
Valerio Setti4e2f2442023-08-15 10:10:26 +02003168# This is a common configuration helper used directly from:
3169# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3170# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3171# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003172# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003173# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003174# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003175# - this is the reference component of the above
3176# - it still disables RSA and FFDH, but it uses builtin EC algs
3177# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3178# - accelerate all EC and FFDH algs, disable only RSA
3179# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3180# - this is the reference component of the above
3181# - it still disables RSA, but it uses builtin EC and FFDH algs
3182#
3183# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003184# $1: a boolean value which states if we are testing an accelerated scenario
3185# or not.
3186# $2: a string value which states which components are tested. Allowed values
3187# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003188config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003189 driver_only="$1"
3190 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003191 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003192 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003193
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003194 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003195 # Disable modules that are accelerated
3196 scripts/config.py unset MBEDTLS_ECDSA_C
3197 scripts/config.py unset MBEDTLS_ECDH_C
3198 scripts/config.py unset MBEDTLS_ECJPAKE_C
3199 # Disable ECP module (entirely)
3200 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003201 # Also disable bignum
3202 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003203 fi
3204
3205 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3206 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3207 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3208 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3209
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003210 # RSA support is intentionally disabled on this test because RSA_C depends
3211 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003212 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3213 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 +02003214 scripts/config.py unset MBEDTLS_RSA_C
3215 scripts/config.py unset MBEDTLS_PKCS1_V15
3216 scripts/config.py unset MBEDTLS_PKCS1_V21
3217 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3218 # Also disable key exchanges that depend on RSA
3219 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3220 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3221 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3222 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3223 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3224
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003225 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003226 # When testing ECC only, we disable FFDH support, both from builtin and
3227 # PSA sides, and also disable the key exchanges that depend on DHM.
3228 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3229 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 +01003230 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003231 scripts/config.py unset MBEDTLS_DHM_C
3232 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3233 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3234 else
3235 # When testing ECC and DH instead, we disable DHM and depending key
3236 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003237 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003238 scripts/config.py unset MBEDTLS_DHM_C
3239 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3240 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3241 fi
3242 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003243
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003244 # Restartable feature is not yet supported by PSA. Once it will in
3245 # the future, the following line could be removed (see issues
3246 # 6061, 6332 and following ones)
3247 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3248}
3249
Valerio Setti4e2f2442023-08-15 10:10:26 +02003250# Common helper used by:
3251# - component_test_psa_crypto_config_accel_ecc_no_bignum
3252# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003253#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003254# The goal is to build and test accelerating either:
3255# - ECC only or
3256# - both ECC and FFDH
3257#
3258# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003259# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3260# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003261common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003262 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003263
Valerio Setti5dfaca42023-09-05 08:48:51 +02003264 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003265 if [ "$test_target" = "ECC_DH" ]; then
3266 accel_text="ECC/FFDH"
3267 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003268 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003269 accel_text="ECC"
3270 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003271 fi
3272
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003273 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003274
3275 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003276 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3277 ALG_ECDH \
3278 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003279 $(helper_get_psa_key_type_list "ECC") \
3280 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003281 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003282 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003283 loc_accel_list="$loc_accel_list \
3284 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003285 $(helper_get_psa_key_type_list "DH") \
3286 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003287 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003288
3289 # Configure
3290 # ---------
3291
3292 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003293 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003294 # Disable all the builtin curves. All the required algs are accelerated.
3295 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003296
3297 # Build
3298 # -----
3299
3300 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003301 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3302 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3303 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003304
3305 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3306
Valerio Setti3fe105b2023-10-30 11:08:12 +01003307 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003308
3309 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3310 not grep mbedtls_ecdsa_ library/ecdsa.o
3311 not grep mbedtls_ecdh_ library/ecdh.o
3312 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003313 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003314 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003315 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003316 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003317 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003318
3319 # Run the tests
3320 # -------------
3321
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003322 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003323
Gilles Peskine21570cf2023-12-22 11:49:50 +01003324 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003325
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003326 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003327 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003328}
3329
Valerio Setti4e2f2442023-08-15 10:10:26 +02003330# Common helper used by:
3331# - component_test_psa_crypto_config_reference_ecc_no_bignum
3332# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3333#
3334# The goal is to build and test a reference scenario (i.e. with builtin
3335# components) compared to the ones used in
3336# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3337#
3338# It is meant to be used in conjunction with
3339# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3340# coverage analysis in "analyze_outcomes.py" script.
3341common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003342 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003343
Valerio Setti5dfaca42023-09-05 08:48:51 +02003344 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003345 if [ "$test_target" = "ECC_DH" ]; then
3346 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003347 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003348 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003349 fi
3350
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003351 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003352
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003353 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003354
Gilles Peskine21570cf2023-12-22 11:49:50 +01003355 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003356
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003357 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003358 make test
3359
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003360 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003361 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003362}
3363
Valerio Setti4e2f2442023-08-15 10:10:26 +02003364component_test_psa_crypto_config_accel_ecc_no_bignum () {
3365 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3366}
3367
3368component_test_psa_crypto_config_reference_ecc_no_bignum () {
3369 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3370}
3371
3372component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3373 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3374}
3375
3376component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3377 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3378}
3379
Valerio Settiac6d35f2023-08-04 12:49:11 +02003380# Helper for setting common configurations between:
3381# - component_test_tfm_config_p256m_driver_accel_ec()
3382# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003383common_tfm_config () {
3384 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003385 cp configs/config-tfm.h "$CONFIG_H"
3386 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3387 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003388
Yanray Wang73bb2312023-09-25 11:21:15 +08003389 # Other config adjustment to make the tests pass.
3390 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003391 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003392 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3393 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003394
Yanray Wang73bb2312023-09-25 11:21:15 +08003395 # Config adjustment for better test coverage in our environment.
3396 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003397 #
3398 # Enable filesystem I/O for the benefit of PK parse/write tests.
3399 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3400}
3401
Valerio Settiac6d35f2023-08-04 12:49:11 +02003402# Keep this in sync with component_test_tfm_config() as they are both meant
3403# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003404component_test_tfm_config_p256m_driver_accel_ec () {
3405 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3406
3407 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003408
Dave Rodgman897bb772023-11-15 16:34:20 +00003409 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003410 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003411
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003412 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3413 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003414 not grep mbedtls_ecdh_ library/ecdh.o
3415 not grep mbedtls_ecjpake_ library/ecjpake.o
3416 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3417 not grep mbedtls_ecp_ library/ecp.o
3418 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003419 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003420 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003421 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003422 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003423
Valerio Setti5e18b902023-12-04 12:07:30 +01003424 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3425 # files, so we want to ensure that it has not be re-enabled accidentally.
3426 not grep mbedtls_cipher library/cipher.o
3427
Valerio Settib7e95442023-03-21 11:52:33 +01003428 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003429 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003430 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003431}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003432
Valerio Settiac6d35f2023-08-04 12:49:11 +02003433# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3434# they are both meant to be used in analyze_outcomes.py for driver's coverage
3435# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003436component_test_tfm_config() {
3437 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003438
Dave Rodgman897bb772023-11-15 16:34:20 +00003439 # Disable P256M driver, which is on by default, so that analyze_outcomes
3440 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3441 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3442
Valerio Setti52ba0e32023-08-04 12:43:03 +02003443 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003444 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003445
Dave Rodgman897bb772023-11-15 16:34:20 +00003446 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003447 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003448
Valerio Setti5e18b902023-12-04 12:07:30 +01003449 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3450 # files, so we want to ensure that it has not be re-enabled accidentally.
3451 not grep mbedtls_cipher library/cipher.o
3452
Valerio Setti52ba0e32023-08-04 12:43:03 +02003453 msg "test: TF-M config"
3454 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003455}
3456
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003457# Common helper for component_full_without_ecdhe_ecdsa() and
3458# component_full_without_ecdhe_ecdsa_and_tls13() which:
3459# - starts from the "full" configuration minus the list of symbols passed in
3460# as 1st parameter
3461# - build
3462# - test only TLS (i.e. test_suite_tls and ssl-opt)
3463build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003464 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003465
3466 msg "build: full minus something, test TLS"
3467
3468 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003469 for sym in $symbols_to_disable; do
3470 echo "Disabling $sym"
3471 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003472 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003473
Gilles Peskine21570cf2023-12-22 11:49:50 +01003474 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003475
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003476 msg "test: full minus something, test TLS"
3477 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003478
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003479 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003480 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003481}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003482
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003483component_full_without_ecdhe_ecdsa () {
3484 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003485}
3486
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003487component_full_without_ecdhe_ecdsa_and_tls13 () {
3488 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3489 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003490}
3491
Valerio Setti249b18a2023-06-20 12:08:30 +02003492# This is an helper used by:
3493# - component_test_psa_ecc_key_pair_no_derive
3494# - component_test_psa_ecc_key_pair_no_generate
3495# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3496# enabled, but one. Input arguments are as follows:
3497# - $1 is the key type under test, i.e. ECC/RSA/DH
3498# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003499build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003500 key_type=$1
3501 unset_option=$2
3502 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003503
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003504 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003505 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003506 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3507 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3508
3509 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3510 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003511 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003512
Gilles Peskine21570cf2023-12-22 11:49:50 +01003513 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003514
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003515 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003516 make test
3517}
3518
3519component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003520 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003521}
3522
3523component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003524 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003525}
3526
Pengyu Lve705f572023-12-06 16:38:15 +08003527config_psa_crypto_accel_rsa () {
3528 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003529
Pengyu Lve705f572023-12-06 16:38:15 +08003530 # Start from crypto_full config (no X.509, no TLS)
3531 helper_libtestdriver1_adjust_config "crypto_full"
3532
3533 if [ "$driver_only" -eq 1 ]; then
3534 # Remove RSA support and its dependencies
3535 scripts/config.py unset MBEDTLS_RSA_C
3536 scripts/config.py unset MBEDTLS_PKCS1_V15
3537 scripts/config.py unset MBEDTLS_PKCS1_V21
3538
3539 # We need PEM parsing in the test library as well to support the import
3540 # of PEM encoded RSA keys.
3541 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3542 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3543 fi
3544}
3545
3546component_test_psa_crypto_config_accel_rsa_crypto () {
3547 msg "build: crypto_full with accelerated RSA"
3548
3549 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3550 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3551 KEY_TYPE_RSA_PUBLIC_KEY \
3552 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3553 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3554 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3555 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003556
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003557 # Configure
3558 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003559
Pengyu Lve705f572023-12-06 16:38:15 +08003560 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003561
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003562 # Build
3563 # -----
3564
Pengyu Lve705f572023-12-06 16:38:15 +08003565 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003566 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 +08003567 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003568 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003569
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003570 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003571
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003572 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003573 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003574
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003575 # Run the tests
3576 # -------------
3577
Pengyu Lve705f572023-12-06 16:38:15 +08003578 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003579 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003580}
3581
3582component_test_psa_crypto_config_reference_rsa_crypto () {
3583 msg "build: crypto_full with non-accelerated RSA"
3584
3585 # Configure
3586 # ---------
3587 config_psa_crypto_accel_rsa 0
3588
3589 # Build
3590 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003591 make
Pengyu Lve705f572023-12-06 16:38:15 +08003592
3593 # Run the tests
3594 # -------------
3595 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003596 make test
3597}
3598
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003599# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003600# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003601component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003602 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003603
Valerio Setti4590bc22023-06-13 15:39:23 +02003604 # Create a temporary output file unless there is already one set
3605 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3606 REMOVE_OUTCOME_ON_EXIT="no"
3607 else
3608 REMOVE_OUTCOME_ON_EXIT="yes"
3609 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3610 export MBEDTLS_TEST_OUTCOME_FILE
3611 fi
3612
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003613 # Start from crypto configuration
3614 scripts/config.py crypto
3615
3616 # Remove RSA support and its dependencies
3617 scripts/config.py unset MBEDTLS_PKCS1_V15
3618 scripts/config.py unset MBEDTLS_PKCS1_V21
3619 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3620 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3621 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3622 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3623 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3624 scripts/config.py unset MBEDTLS_RSA_C
3625 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3626
3627 # Enable PSA support
3628 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3629
Valerio Setti01cc88a2023-06-15 11:53:08 +02003630 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003631 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003632 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3633 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3634 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003635
3636 make
3637
Valerio Setti01cc88a2023-06-15 11:53:08 +02003638 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003639 make test
3640
3641 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3642 # performing RSA signature.
3643 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3644 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3645
3646 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3647 rm $MBEDTLS_TEST_OUTCOME_FILE
3648 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003649}
3650
Ronald Cronb2312452021-05-08 14:32:59 +02003651component_test_psa_crypto_config_accel_hash () {
3652 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3653
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003654 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3655 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3656 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003657
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003658 # Configure
3659 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003660
Ronald Cron46ac0652024-03-18 12:39:04 +01003661 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003662 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003663
3664 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003665 scripts/config.py unset MBEDTLS_MD5_C
3666 scripts/config.py unset MBEDTLS_RIPEMD160_C
3667 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003668 scripts/config.py unset MBEDTLS_SHA224_C
3669 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003670 scripts/config.py unset MBEDTLS_SHA384_C
3671 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003672 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003673
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003674 # Build
3675 # -----
3676
3677 helper_libtestdriver1_make_drivers "$loc_accel_list"
3678
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003679 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003680
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003681 # There's a risk of something getting re-enabled via config_psa.h;
3682 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3683 not grep mbedtls_md5 library/md5.o
3684 not grep mbedtls_sha1 library/sha1.o
3685 not grep mbedtls_sha256 library/sha256.o
3686 not grep mbedtls_sha512 library/sha512.o
3687 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003688
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003689 # Run the tests
3690 # -------------
3691
Ronald Cronb2312452021-05-08 14:32:59 +02003692 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3693 make test
3694}
3695
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003696# Auxiliary function to build config for hashes with and without drivers
3697config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003698 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003699 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003700 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003701 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003702 # disable the built-in implementation of hashes
3703 scripts/config.py unset MBEDTLS_MD5_C
3704 scripts/config.py unset MBEDTLS_RIPEMD160_C
3705 scripts/config.py unset MBEDTLS_SHA1_C
3706 scripts/config.py unset MBEDTLS_SHA224_C
3707 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003708 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003709 scripts/config.py unset MBEDTLS_SHA384_C
3710 scripts/config.py unset MBEDTLS_SHA512_C
3711 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003712 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003713 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003714}
3715
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003716# Note that component_test_psa_crypto_config_reference_hash_use_psa
3717# is related to this component and both components need to be kept in sync.
3718# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003719component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003720 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003721
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003722 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3723 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3724 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003725
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003726 # Configure
3727 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003728
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003729 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003730
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003731 # Build
3732 # -----
3733
3734 helper_libtestdriver1_make_drivers "$loc_accel_list"
3735
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003736 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003737
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003738 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003739 # 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 +02003740 not grep mbedtls_md5 library/md5.o
3741 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003742 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003743 not grep mbedtls_sha512 library/sha512.o
3744 not grep mbedtls_ripemd160 library/ripemd160.o
3745
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003746 # Run the tests
3747 # -------------
3748
Gilles Peskine14302ed2023-07-19 19:30:04 +02003749 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003750 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003751
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003752 # This is mostly useful so that we can later compare outcome files with
3753 # the reference config in analyze_outcomes.py, to check that the
3754 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003755 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003756 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003757
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003758 # This is to make sure all ciphersuites are exercised, but we don't need
3759 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003760 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003761 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003762}
3763
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003764# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3765# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3766# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3767# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003768component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003769 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003770
3771 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003772
Gilles Peskine21570cf2023-12-22 11:49:50 +01003773 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003774
Gilles Peskine14302ed2023-07-19 19:30:04 +02003775 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003776 make test
3777
Gilles Peskine14302ed2023-07-19 19:30:04 +02003778 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003779 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003780}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003781
Valerio Setti8eb310c2024-01-22 16:22:57 +01003782# Auxiliary function to build config for hashes with and without drivers
3783config_psa_crypto_hmac_use_psa () {
3784 driver_only="$1"
3785 # start with config full for maximum coverage (also enables USE_PSA)
3786 helper_libtestdriver1_adjust_config "full"
3787
Valerio Setticd89b0b2024-01-24 14:24:55 +01003788 if [ "$driver_only" -eq 1 ]; then
3789 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3790 # is still enabled though (for ENTROPY_C among others).
3791 scripts/config.py unset MBEDTLS_MD_C
3792 # Disable also the builtin hashes since they are supported by the driver
3793 # and MD module is able to perform PSA dispathing.
3794 scripts/config.py unset-all MBEDTLS_SHA
3795 scripts/config.py unset MBEDTLS_MD5_C
3796 scripts/config.py unset MBEDTLS_RIPEMD160_C
3797 fi
3798
Valerio Setti8eb310c2024-01-22 16:22:57 +01003799 # Direct dependencies of MD_C. We disable them also in the reference
3800 # component to work with the same set of features.
3801 scripts/config.py unset MBEDTLS_PKCS7_C
3802 scripts/config.py unset MBEDTLS_PKCS5_C
3803 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3804 scripts/config.py unset MBEDTLS_HKDF_C
3805 # Dependencies of HMAC_DRBG
3806 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3807 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3808}
3809
3810component_test_psa_crypto_config_accel_hmac() {
3811 msg "test: full with accelerated hmac"
3812
3813 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3814 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3815 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3816 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3817
3818 # Configure
3819 # ---------
3820
3821 config_psa_crypto_hmac_use_psa 1
3822
Valerio Setti8eb310c2024-01-22 16:22:57 +01003823 # Build
3824 # -----
3825
3826 helper_libtestdriver1_make_drivers "$loc_accel_list"
3827
3828 helper_libtestdriver1_make_main "$loc_accel_list"
3829
3830 # Ensure that built-in support for HMAC is disabled.
3831 not grep mbedtls_md_hmac library/md.o
3832
3833 # Run the tests
3834 # -------------
3835
3836 msg "test: full with accelerated hmac"
3837 make test
3838}
3839
3840component_test_psa_crypto_config_reference_hmac() {
3841 msg "test: full without accelerated hmac"
3842
3843 config_psa_crypto_hmac_use_psa 0
3844
3845 make
3846
3847 msg "test: full without accelerated hmac"
3848 make test
3849}
3850
Valerio Setti9da01a72023-12-18 17:38:18 +01003851component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003852 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003853
Valerio Setti9da01a72023-12-18 17:38:18 +01003854 # Albeit this components aims at accelerating DES which should only support
3855 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3856 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003857 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3858 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3859 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003860
Valerio Setti9da01a72023-12-18 17:38:18 +01003861 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3862 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3863 # of this component. This limitation will be addressed by #8598.
3864
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003865 # Configure
3866 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003867
Valerio Setti9a427302023-10-17 11:40:42 +02003868 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003869 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003870
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003871 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003872 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3873 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3874 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3875 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3876 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3877 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3878 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003879 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003880
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003881 # Build
3882 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003883
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003884 helper_libtestdriver1_make_drivers "$loc_accel_list"
3885
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003886 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003887
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003888 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003889 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003890
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003891 # Run the tests
3892 # -------------
3893
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003894 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003895 make test
3896}
3897
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003898component_test_psa_crypto_config_accel_aead () {
3899 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3900
Valerio Setti3f02bb72023-10-02 15:57:33 +02003901 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3902 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003903
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003904 # Configure
3905 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003906
Valerio Setti3f02bb72023-10-02 15:57:33 +02003907 # Start from full config
3908 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003909
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003910 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003911 scripts/config.py unset MBEDTLS_GCM_C
3912 scripts/config.py unset MBEDTLS_CCM_C
3913 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003914
Valerio Settia50b89e2023-11-08 15:58:47 +01003915 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3916 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003917
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003918 # Build
3919 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +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"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003924
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003925 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003926 not grep mbedtls_ccm library/ccm.o
3927 not grep mbedtls_gcm library/gcm.o
3928 not grep mbedtls_chachapoly library/chachapoly.o
3929
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003930 # Run the tests
3931 # -------------
3932
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003933 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3934 make test
3935}
3936
Valerio Settib680fc42023-10-13 09:29:37 +02003937# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003938# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3939# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3940common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003941 # Start from the full config
3942 helper_libtestdriver1_adjust_config "full"
3943
Valerio Settib680fc42023-10-13 09:29:37 +02003944 scripts/config.py unset MBEDTLS_NIST_KW_C
3945}
3946
Valerio Settib6b301f2023-10-04 12:05:05 +02003947# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003948# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3949# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003950# are meant to be used together in analyze_outcomes.py script in order to test
3951# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003952component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3953 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003954
Valerio Settiad8b7f02023-10-25 12:39:50 +02003955 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 +01003956 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003957 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003958 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3959
3960 # Configure
3961 # ---------
3962
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003963 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003964
3965 # Disable the things that are being accelerated
3966 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3967 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3968 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3969 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3970 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3971 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3972 scripts/config.py unset MBEDTLS_GCM_C
3973 scripts/config.py unset MBEDTLS_CCM_C
3974 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003975 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003976 scripts/config.py unset MBEDTLS_DES_C
3977 scripts/config.py unset MBEDTLS_AES_C
3978 scripts/config.py unset MBEDTLS_ARIA_C
3979 scripts/config.py unset MBEDTLS_CHACHA20_C
3980 scripts/config.py unset MBEDTLS_CAMELLIA_C
3981
Valerio Settiec9b2582023-11-08 16:50:54 +01003982 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3983 # does not depend on it.
3984 scripts/config.py unset MBEDTLS_CIPHER_C
3985
Valerio Settib6b301f2023-10-04 12:05:05 +02003986 # Build
3987 # -----
3988
3989 helper_libtestdriver1_make_drivers "$loc_accel_list"
3990
3991 helper_libtestdriver1_make_main "$loc_accel_list"
3992
3993 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003994 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003995 not grep mbedtls_des library/des.o
3996 not grep mbedtls_aes library/aes.o
3997 not grep mbedtls_aria library/aria.o
3998 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003999 not grep mbedtls_ccm library/ccm.o
4000 not grep mbedtls_gcm library/gcm.o
4001 not grep mbedtls_chachapoly library/chachapoly.o
4002 not grep mbedtls_cmac library/cmac.o
4003
4004 # Run the tests
4005 # -------------
4006
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004007 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004008 make test
Valerio Settif9414552023-11-09 10:43:20 +01004009
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004010 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004011 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004012
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004013 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004014 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004015}
4016
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004017component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4018 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4019 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004020
Gilles Peskine21570cf2023-12-22 11:49:50 +01004021 make
Valerio Settif9414552023-11-09 10:43:20 +01004022
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004023 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004024 make test
Valerio Settif9414552023-11-09 10:43:20 +01004025
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004026 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004027 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004028
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004029 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004030 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004031}
4032
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004033common_block_cipher_dispatch() {
4034 TEST_WITH_DRIVER="$1"
4035
4036 # Start from the full config
4037 helper_libtestdriver1_adjust_config "full"
4038
4039 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4040 # Disable key types that are accelerated (there is no legacy equivalent
4041 # symbol for ECB)
4042 scripts/config.py unset MBEDTLS_AES_C
4043 scripts/config.py unset MBEDTLS_ARIA_C
4044 scripts/config.py unset MBEDTLS_CAMELLIA_C
4045 fi
4046
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004047 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004048 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004049 # Keep this also in the reference component in order to skip the same tests
4050 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004051 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4052 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4053 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4054 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4055 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4056 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4057 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02004058 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004059
4060 # Disable direct dependency on AES_C
4061 scripts/config.py unset MBEDTLS_NIST_KW_C
4062
4063 # Prevent the cipher module from using deprecated PSA path. The reason is
4064 # that otherwise there will be tests relying on "aes_info" (defined in
4065 # "cipher_wrap.c") whose functions are not available when AES_C is
4066 # not defined. ARIA and Camellia are not a problem in this case because
4067 # the PSA path is not tested for these key types.
4068 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4069}
4070
Valerio Settif8e6cba2023-12-12 11:53:39 +01004071component_test_full_block_cipher_psa_dispatch () {
4072 msg "build: full + PSA dispatch in block_cipher"
4073
4074 loc_accel_list="ALG_ECB_NO_PADDING \
4075 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4076
4077 # Configure
4078 # ---------
4079
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004080 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004081
Valerio Settif8e6cba2023-12-12 11:53:39 +01004082 # Build
4083 # -----
4084
4085 helper_libtestdriver1_make_drivers "$loc_accel_list"
4086
4087 helper_libtestdriver1_make_main "$loc_accel_list"
4088
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004089 # Make sure disabled components were not re-enabled by accident (additive
4090 # config)
4091 not grep mbedtls_aes_ library/aes.o
4092 not grep mbedtls_aria_ library/aria.o
4093 not grep mbedtls_camellia_ library/camellia.o
4094
Valerio Settif8e6cba2023-12-12 11:53:39 +01004095 # Run the tests
4096 # -------------
4097
4098 msg "test: full + PSA dispatch in block_cipher"
4099 make test
4100}
4101
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004102# This is the reference component of component_test_full_block_cipher_psa_dispatch
4103component_test_full_block_cipher_legacy_dispatch () {
4104 msg "build: full + legacy dispatch in block_cipher"
4105
4106 common_block_cipher_dispatch 0
4107
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004108 make
4109
4110 msg "test: full + legacy dispatch in block_cipher"
4111 make test
4112}
4113
Gilles Peskine36dea152023-07-20 22:19:45 +02004114component_test_aead_chachapoly_disabled() {
4115 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004116 scripts/config.py full
4117 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004118 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004119 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004120
Gilles Peskine36dea152023-07-20 22:19:45 +02004121 msg "test: full minus CHACHAPOLY"
4122 make test
4123}
4124
4125component_test_aead_only_ccm() {
4126 msg "build: full minus CHACHAPOLY and GCM"
4127 scripts/config.py full
4128 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4129 scripts/config.py unset MBEDTLS_GCM_C
4130 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4131 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004132 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004133
4134 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004135 make test
4136}
4137
Ronald Crone501d0e2023-07-10 08:31:19 +02004138component_test_ccm_aes_sha256() {
4139 msg "build: CCM + AES + SHA256 configuration"
4140
Ronald Cron7612d8c2023-07-20 10:03:54 +02004141 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004142 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004143
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004144 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004145
4146 msg "test: CCM + AES + SHA256 configuration"
4147 make test
4148}
4149
Dave Rodgman904c5892023-06-28 17:36:02 +01004150support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004151 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004152}
4153
Dave Rodgman904c5892023-06-28 17:36:02 +01004154component_build_tfm_armcc() {
4155 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004156 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004157
Dave Rodgman88651c42023-06-29 12:35:51 +01004158 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004159 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 +01004160}
4161
4162component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004163 # Check that the TF-M configuration can build cleanly with various
4164 # warning flags enabled. We don't build or run tests, since the
4165 # TF-M configuration needs a TF-M platform. A tweaked version of
4166 # the configuration that works on mainstream platforms is in
4167 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004168 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004169
Dave Rodgman88651c42023-06-29 12:35:51 +01004170 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004171 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 +01004172
Dave Rodgman904c5892023-06-28 17:36:02 +01004173 msg "build: TF-M config, gcc native build"
4174 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004175 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 +01004176}
4177
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004178# Test that the given .o file builds with all (valid) combinations of the given options.
4179#
4180# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4181#
4182# The validator function is the name of a function to validate the combination of options.
4183# It may be "" if all combinations are valid.
4184# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004185# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004186build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004187 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004188 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004189 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004190 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004191 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004192
Dave Rodgman42436102023-10-03 15:47:05 +01004193 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004194 for opt in "${options[@]}"; do
4195 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004196 done
4197
4198 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004199 cd $(dirname ${file})
4200 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004201
Dave Rodgman920343a2023-10-01 18:41:09 +01004202 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004203 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 +01004204
Dave Rodgman42436102023-10-03 15:47:05 +01004205 # Extract the command generated by the Makefile to build the target file.
4206 # This ensures that we have any include paths, macro definitions, etc
4207 # that may be applied by make.
4208 # 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 +01004209 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004210
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004211 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004212 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004213
Dave Rodgman28e38d82023-10-04 11:50:30 +01004214 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004215 source_file=${file%.o}.c
4216
4217 targets=0
4218 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004219
Dave Rodgman28e38d82023-10-04 11:50:30 +01004220 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004221 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004222 # each bit of $i is used to determine if options[i] will be set or not
4223 target="t"
4224 clang_args=""
4225 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004226 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004227 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004228 clang_args="${clang_args} ${opt}"
4229 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004230 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004231 done
4232
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004233 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004234 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004235 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004236 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004237
Dave Rodgman28e38d82023-10-04 11:50:30 +01004238 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004239 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004240 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004241 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004242
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004243 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004244
Dave Rodgman920343a2023-10-01 18:41:09 +01004245 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004246 make -s -f ${makefile} build_test_config_combos
4247 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004248
4249 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004250 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004251}
4252
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004253validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004254 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004255 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4256 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004257 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004258 fi
4259 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004260 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004261}
4262
4263component_build_aes_variations() {
4264 # 18s - around 90ms per clang invocation on M1 Pro
4265 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004266 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004267 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004268
Yanray Wangbc29aef2023-11-06 11:08:17 +08004269 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004270 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004271
Dave Rodgman42436102023-10-03 15:47:05 +01004272 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004273 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4274 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004275 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004276 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004277
4278 cd "$MBEDTLS_ROOT_DIR"
4279 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4280
Yanray Wang42be1ba2023-11-23 14:28:47 +08004281 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004282 # manually set or unset those configurations to check
4283 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004284 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4285 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4286 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4287 scripts/config.py unset MBEDTLS_DES_C
4288 scripts/config.py unset MBEDTLS_NIST_KW_C
4289 build_test_config_combos library/aes.o validate_aes_config_variations \
4290 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4291 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004292 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004293 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004294}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004295
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004296component_test_no_platform () {
4297 # Full configuration build, without platform support, file IO and net sockets.
4298 # This should catch missing mbedtls_printf definitions, and by disabling file
4299 # IO, it should catch missing '#include <stdio.h>'
4300 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004301 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004302 scripts/config.py unset MBEDTLS_PLATFORM_C
4303 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004304 scripts/config.py unset MBEDTLS_FS_IO
4305 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004306 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004307 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004308 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004309 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004310 # to re-enable platform integration features otherwise disabled in C99 builds
4311 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004312 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004313}
Gilles Peskine7c652162017-12-11 00:01:40 +01004314
4315component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004316 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004317 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4318 scripts/config.py full
4319 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004320 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4321 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4322 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4323 make
4324}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004325
Gilles Peskine8f073122018-11-27 15:58:47 +01004326component_build_no_ssl_srv () {
4327 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004328 scripts/config.py full
4329 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004330 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004331}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004332
Gilles Peskine8f073122018-11-27 15:58:47 +01004333component_build_no_ssl_cli () {
4334 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004335 scripts/config.py full
4336 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004337 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004338}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004339
Gilles Peskine8f073122018-11-27 15:58:47 +01004340component_build_no_sockets () {
4341 # Note, C99 compliance can also be tested with the sockets support disabled,
4342 # as that requires a POSIX platform (which isn't the same as C99).
4343 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004344 scripts/config.py full
4345 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4346 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4347 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4348}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004349
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004350component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004351 msg "build: default config with memory buffer allocator and backtrace enabled"
4352 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4353 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4354 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004355 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004356 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004357 make
4358
4359 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4360 make test
4361}
4362
4363component_test_memory_buffer_allocator () {
4364 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004365 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4366 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004367 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004368 make
4369
4370 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4371 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004372
4373 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4374 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004375 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004376}
4377
Gilles Peskine8f073122018-11-27 15:58:47 +01004378component_test_no_max_fragment_length () {
4379 # Run max fragment length tests with MFL disabled
4380 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004381 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004382 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004383 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004384
Gilles Peskine8f073122018-11-27 15:58:47 +01004385 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004386 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004387}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004388
Hanno Becker545ced42019-02-19 11:10:48 +00004389component_test_asan_remove_peer_certificate () {
4390 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004391 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004392 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004393 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004394 make
4395
4396 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4397 make test
4398
4399 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004400 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004401
4402 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004403 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004404
4405 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004406 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004407}
4408
Gilles Peskine8f073122018-11-27 15:58:47 +01004409component_test_no_max_fragment_length_small_ssl_out_content_len () {
4410 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004411 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4412 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4413 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004414 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004415 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004416
Gilles Peskine8f073122018-11-27 15:58:47 +01004417 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004418 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004419
4420 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004421 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004422}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004423
Darryl Greenaad82f92019-12-02 10:53:11 +00004424component_test_variable_ssl_in_out_buffer_len () {
4425 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4426 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004427 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004428 make
4429
4430 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4431 make test
4432
4433 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004434 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004435
4436 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004437 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004438}
4439
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004440component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004441 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004442 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004443
Dave Rodgman17127e92023-12-14 16:42:48 +00004444 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004445 make
4446
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004447 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004448 make test
4449
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004450 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004451 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004452
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004453 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004454 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004455}
4456
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004457component_test_ssl_alloc_buffer_and_mfl () {
4458 msg "build: default config with memory buffer allocator and MFL extension"
4459 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4460 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4461 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4462 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4463 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004464 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004465 make
4466
4467 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4468 make test
4469
4470 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 +02004471 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004472}
4473
Gilles Peskine636c26a2020-03-04 20:46:15 +01004474component_test_when_no_ciphersuites_have_mac () {
4475 msg "build: when no ciphersuites have MAC"
4476 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004477 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004478 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004479 make
4480
4481 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4482 make test
4483
4484 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004485 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004486}
4487
Raoul Strackxa4e86142020-06-15 17:03:13 +02004488component_test_no_date_time () {
4489 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4490 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004491 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004492 make
4493
4494 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4495 make test
4496}
4497
Gilles Peskine8f073122018-11-27 15:58:47 +01004498component_test_platform_calloc_macro () {
4499 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004500 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4501 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4502 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004503 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004504 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004505
Gilles Peskine8f073122018-11-27 15:58:47 +01004506 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4507 make test
4508}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004509
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004510component_test_malloc_0_null () {
4511 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004512 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004513 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 +02004514
4515 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4516 make test
4517
4518 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4519 # Just the calloc selftest. "make test" ran the others as part of the
4520 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004521 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004522
4523 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4524 # Run a subset of the tests. The choice is a balance between coverage
4525 # and time (including time indirectly wasted due to flaky tests).
4526 # The current choice is to skip tests whose description includes
4527 # "proxy", which is an approximation of skipping tests that use the
4528 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004529 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004530}
4531
Dave Rodgman6a08b682023-06-19 11:51:33 +01004532support_test_aesni() {
4533 # Check that gcc targets x86_64 (we can build AESNI), and check for
4534 # AESNI support on the host (we can run AESNI).
4535 #
4536 # The name of this function is possibly slightly misleading, but needs to align
4537 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004538 #
4539 # In principle 32-bit x86 can support AESNI, but our implementation does not
4540 # support 32-bit x86, so we check for x86-64.
4541 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004542 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4543 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004544 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004545}
4546
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004547component_test_aesni () { # ~ 60s
4548 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4549 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4550 #
4551 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4552 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4553 # exercise the plain C impl).
4554
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004555 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004556 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004557 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004558 scripts/config.py set MBEDTLS_HAVE_ASM
4559
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004560 # test the intrinsics implementation
4561 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004562 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004563 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004564 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004565 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004566
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004567 # test the asm implementation
4568 msg "AES tests, test assembly"
4569 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004570 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004571 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004572 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004573
4574 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004575 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004576 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004577 msg "AES tests, plain C"
4578 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004579 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004580 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004581 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004582 not grep -q "AES note: using AESNI" ./programs/test/selftest
4583 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004584
4585 # test the intrinsics implementation
4586 scripts/config.py set MBEDTLS_AESNI_C
4587 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4588 msg "AES tests, test AESNI only"
4589 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004590 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004591 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4592 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004593 grep -q "AES note: using AESNI" ./programs/test/selftest
4594 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004595}
4596
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004597component_test_sha3_variations() {
4598 msg "sha3 loop unroll variations"
4599
4600 # define minimal config sufficient to test SHA3
4601 cat > include/mbedtls/mbedtls_config.h << END
4602 #define MBEDTLS_SELF_TEST
4603 #define MBEDTLS_SHA3_C
4604END
4605
4606 msg "all loops unrolled"
4607 make clean
4608 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"
4609 ./tests/test_suite_shax
4610
4611 msg "all loops rolled up"
4612 make clean
4613 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"
4614 ./tests/test_suite_shax
4615}
4616
Jerry Yub6d39c22023-08-16 15:11:48 +08004617support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004618 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004619}
4620
4621component_test_aesni_m32 () { # ~ 60s
4622 # This tests are duplicated from component_test_aesni for i386 target
4623 #
4624 # AESNI intrinsic code supports i386 and assembly code does not support it.
4625
4626 msg "build: default config with different AES implementations"
4627 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004628 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4629 scripts/config.py set MBEDTLS_HAVE_ASM
4630
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004631 # test the intrinsics implementation with gcc
4632 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004633 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004634 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004635 # check that we built intrinsics - this should be used by default when supported by the compiler
4636 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4637 grep -q "AES note: using AESNI" ./programs/test/selftest
4638 grep -q "AES note: built-in implementation." ./programs/test/selftest
4639 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4640 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4641
4642 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004643 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4644 msg "AES tests, test AESNI only"
4645 make clean
4646 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4647 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4648 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4649 grep -q "AES note: using AESNI" ./programs/test/selftest
4650 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4651 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4652 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4653}
4654
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004655support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004656 # clang >= 4 is required to build with target attributes
4657 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004658}
4659
4660component_test_aesni_m32_clang() {
4661
4662 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004663 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4664 scripts/config.py set MBEDTLS_HAVE_ASM
4665
4666 # test the intrinsics implementation with clang
4667 msg "AES tests, test intrinsics (clang)"
4668 make clean
4669 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4670 # check that we built intrinsics - this should be used by default when supported by the compiler
4671 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4672 grep -q "AES note: using AESNI" ./programs/test/selftest
4673 grep -q "AES note: built-in implementation." ./programs/test/selftest
4674 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4675 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4676}
4677
Jerry Yu193cbc02023-08-03 17:06:29 +08004678# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4679component_build_aes_aesce_armcc () {
4680 msg "Build: AESCE test on arm64 platform without plain C."
4681 scripts/config.py baremetal
4682
4683 # armc[56] don't support SHA-512 intrinsics
4684 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4685
4686 # Stop armclang warning about feature detection for A64_CRYPTO.
4687 # With this enabled, the library does build correctly under armclang,
4688 # but in baremetal builds (as tested here), feature detection is
4689 # unavailable, and the user is notified via a #warning. So enabling
4690 # this feature would prevent us from building with -Werror on
4691 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004692 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004693 scripts/config.py set MBEDTLS_HAVE_ASM
4694
4695 msg "AESCE, build with default configuration."
4696 scripts/config.py set MBEDTLS_AESCE_C
4697 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4698 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4699
4700 msg "AESCE, build AESCE only"
4701 scripts/config.py set MBEDTLS_AESCE_C
4702 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4703 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4704}
4705
Dave Rodgman0c584032023-10-08 12:26:54 +01004706support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004707 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004708 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004709}
4710
4711component_build_aes_armce () {
4712 # Test variations of AES with Armv8 crypto extensions
4713 scripts/config.py set MBEDTLS_AESCE_C
4714 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4715
4716 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004717 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004718
4719 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4720 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4721
4722 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4723 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4724
Dave Rodgman5e419372023-10-23 15:30:20 +01004725 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004726
Dave Rodgman5e419372023-10-23 15:30:20 +01004727 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4728 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004729
Dave Rodgman5e419372023-10-23 15:30:20 +01004730 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4731 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004732
Dave Rodgman5e419372023-10-23 15:30:20 +01004733 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4734 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004735
4736 # test for presence of AES instructions
4737 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4738 msg "clang, test A32 crypto instructions built"
4739 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4740 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4741 msg "clang, test T32 crypto instructions built"
4742 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4743 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4744 msg "clang, test aarch64 crypto instructions built"
4745 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4746 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4747
4748 # test for absence of AES instructions
4749 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4750 scripts/config.py unset MBEDTLS_AESCE_C
4751 msg "clang, test A32 crypto instructions not built"
4752 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4753 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4754 msg "clang, test T32 crypto instructions not built"
4755 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4756 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4757 msg "clang, test aarch64 crypto instructions not built"
4758 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4759 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004760}
4761
Dave Rodgman9ed18532023-10-05 00:06:47 +01004762support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004763 # clang >= 4 is required to build with SHA extensions
4764 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004765}
4766
Dave Rodgmand9e80832023-10-04 17:17:46 +01004767component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004768 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004769
4770
4771 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004772 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004773 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4774 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4775 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4776 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4777 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004778
Dave Rodgmand9e80832023-10-04 17:17:46 +01004779
Dave Rodgman94a634d2023-10-10 12:59:29 +01004780 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004781 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004782 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4783 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4784 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004785
Dave Rodgman5b89c552023-10-10 14:59:02 +01004786 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004787 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4788 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4789 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004790
Dave Rodgmancd654002023-10-05 09:40:07 +01004791
Dave Rodgman94a634d2023-10-10 12:59:29 +01004792 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004793 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004794 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4795 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4796 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4797 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4798 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004799
Dave Rodgmancd654002023-10-05 09:40:07 +01004800
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004801 # examine the disassembly for presence of SHA instructions
4802 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4803 scripts/config.py set ${opt}
4804 msg "${opt} clang, test A32 crypto instructions built"
4805 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4806 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4807
4808 msg "${opt} clang, test T32 crypto instructions built"
4809 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4810 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4811
4812 msg "${opt} clang, test aarch64 crypto instructions built"
4813 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4814 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4815 scripts/config.py unset ${opt}
4816 done
4817
4818
4819 # examine the disassembly for absence of SHA instructions
4820 msg "clang, test A32 crypto instructions not built"
4821 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4822 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4823
4824 msg "clang, test T32 crypto instructions not built"
4825 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4826 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4827
4828 msg "clang, test aarch64 crypto instructions not built"
4829 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4830 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004831}
4832
Jerry Yu193cbc02023-08-03 17:06:29 +08004833support_build_aes_aesce_armcc () {
4834 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004835}
4836
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004837component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004838 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004839 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004840
Dave Rodgmand8d64512023-12-19 12:20:21 +00004841 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004842
4843 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4844 make test
4845}
4846
4847component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4848 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4849 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004850 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004851
Hanno Becker83ebf782017-07-07 12:29:15 +01004852 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004853
4854 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004855 make test
4856}
Gilles Peskine8f073122018-11-27 15:58:47 +01004857
Hanno Becker83ebf782017-07-07 12:29:15 +01004858component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004859 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4860 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004861 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004862 scripts/config.py unset MBEDTLS_AESCE_C
4863
Dave Rodgmand8d64512023-12-19 12:20:21 +00004864 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004865
4866 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004867 make test
4868
4869 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4870 programs/test/selftest
4871}
4872
Matthias Schulz0767fda2024-02-07 10:46:28 +01004873component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004874 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4875 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004876 scripts/config.py unset MBEDTLS_AESNI_C
4877 scripts/config.py unset MBEDTLS_AESCE_C
4878
4879 make CFLAGS='-O2 -Werror -Wall -Wextra'
4880
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004881 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004882 make test
4883}
4884
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004885component_test_aes_fewer_tables () {
4886 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004887 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004888 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004889
Gilles Peskine7c652162017-12-11 00:01:40 +01004890 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004891 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004892}
4893
4894component_test_aes_rom_tables () {
4895 msg "build: default config with AES_ROM_TABLES enabled"
4896 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004897 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004898
4899 msg "test: AES_ROM_TABLES"
4900 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004901}
4902
Gilles Peskine14c3c062018-01-29 21:25:12 +01004903component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004904 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4905 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4906 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004907 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004908
Gilles Peskine8f073122018-11-27 15:58:47 +01004909 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4910 make test
4911}
4912
Yanray Wang49cd4b52023-11-10 11:58:37 +08004913# helper for common_block_cipher_no_decrypt() which:
4914# - enable/disable the list of config options passed from -s/-u respectively.
4915# - build
4916# - test for tests_suite_xxx
4917# - selftest
4918#
4919# Usage: helper_block_cipher_no_decrypt_build_test
4920# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4921# Options: -s set_opts the list of config options to enable
4922# -u unset_opts the list of config options to disable
4923# -c cflags the list of options passed to CFLAGS
4924# -l ldflags the list of options passed to LDFLAGS
4925helper_block_cipher_no_decrypt_build_test () {
4926 while [ $# -gt 0 ]; do
4927 case "$1" in
4928 -s)
4929 shift; local set_opts="$1";;
4930 -u)
4931 shift; local unset_opts="$1";;
4932 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004933 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004934 -l)
4935 shift; local ldflags="$1";;
4936 esac
4937 shift
4938 done
4939 set_opts="${set_opts:-}"
4940 unset_opts="${unset_opts:-}"
4941 cflags="${cflags:-}"
4942 ldflags="${ldflags:-}"
4943
Yanray Wangb2d6e522023-11-13 16:57:47 +08004944 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4945 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004946
4947 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4948 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004949 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004950
4951 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4952 not grep mbedtls_aes_setkey_dec library/aes.o
4953 not grep mbedtls_aria_setkey_dec library/aria.o
4954 not grep mbedtls_camellia_setkey_dec library/camellia.o
4955 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4956 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004957 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4958 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004959
4960 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4961 make test
4962
4963 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4964 programs/test/selftest
4965}
4966
4967# This is a common configuration function used in:
4968# - component_test_block_cipher_no_decrypt_aesni_legacy()
4969# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4970# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4971# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4972# on x86.
4973common_block_cipher_no_decrypt () {
4974 # test AESNI intrinsics
4975 helper_block_cipher_no_decrypt_build_test \
4976 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004977 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004978
4979 # test AESNI assembly
4980 helper_block_cipher_no_decrypt_build_test \
4981 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004982 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004983
4984 # test AES C implementation
4985 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004986 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004987
4988 # test AESNI intrinsics for i386 target
4989 helper_block_cipher_no_decrypt_build_test \
4990 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004991 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004992 -l "-m32"
4993}
4994
Yanray Wang3ae11992023-11-13 17:32:09 +08004995# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4996# usage: 0: no PSA crypto configuration
4997# 1: use PSA crypto configuration
4998config_block_cipher_no_decrypt () {
4999 use_psa=$1
5000
Yanray Wang66111392023-10-31 18:54:54 +08005001 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005002 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5003 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005004 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005005 scripts/config.py unset MBEDTLS_NIST_KW_C
5006
Yanray Wang3ae11992023-11-13 17:32:09 +08005007 if [ "$use_psa" -eq 1 ]; then
5008 # Enable support for cryptographic mechanisms through the PSA API.
5009 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5010 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5011 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5012 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5013 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5014 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5015 fi
5016}
5017
5018component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005019 # This consistently causes an llvm crash on clang 3.8, so use gcc
5020 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005021 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005022 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005023}
5024
Yanray Wangf1496402023-11-01 18:55:13 +08005025component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005026 # This consistently causes an llvm crash on clang 3.8, so use gcc
5027 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005028 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005029 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005030}
5031
Yanray Wang66111392023-10-31 18:54:54 +08005032support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005033 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005034}
5035
Yanray Wang66111392023-10-31 18:54:54 +08005036component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005037 scripts/config.py baremetal
5038
5039 # armc[56] don't support SHA-512 intrinsics
5040 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5041
5042 # Stop armclang warning about feature detection for A64_CRYPTO.
5043 # With this enabled, the library does build correctly under armclang,
5044 # but in baremetal builds (as tested here), feature detection is
5045 # unavailable, and the user is notified via a #warning. So enabling
5046 # this feature would prevent us from building with -Werror on
5047 # armclang. Tracked in #7198.
5048 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5049 scripts/config.py set MBEDTLS_HAVE_ASM
5050
Yanray Wang3ae11992023-11-13 17:32:09 +08005051 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005052
5053 # test AESCE baremetal build
5054 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005055 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005056 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005057
Yanray Wangef1b04d2023-09-08 11:09:26 +08005058 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5059 not grep mbedtls_aes_setkey_dec library/aes.o
5060 not grep mbedtls_aria_setkey_dec library/aria.o
5061 not grep mbedtls_camellia_setkey_dec library/camellia.o
5062 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5063 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005064 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005065 not grep mbedtls_aesce_inverse_key library/aesce.o
5066 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005067}
5068
Gilles Peskine592f5912019-10-07 18:49:32 +02005069component_test_ctr_drbg_aes_256_sha_256 () {
5070 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5071 scripts/config.py full
5072 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5073 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005074 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005075 make
5076
5077 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5078 make test
5079}
5080
5081component_test_ctr_drbg_aes_128_sha_512 () {
5082 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005083 scripts/config.py full
5084 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5085 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005086 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005087 make
5088
5089 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5090 make test
5091}
5092
5093component_test_ctr_drbg_aes_128_sha_256 () {
5094 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005095 scripts/config.py full
5096 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5097 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5098 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005099 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005100 make
5101
5102 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5103 make test
5104}
5105
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005106component_test_se_default () {
5107 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005108 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005109 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005110
5111 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5112 make test
5113}
5114
Steven Cooremand57203d2020-07-16 20:28:59 +02005115component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005116 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005117 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005118 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005119 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5120 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005121 loc_cflags="${loc_cflags} -I../tests/include -O2"
5122
Gilles Peskine21570cf2023-12-22 11:49:50 +01005123 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005124
Gilles Peskine1997f302023-07-26 18:45:20 +02005125 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005126 make test
5127}
5128
Gilles Peskine8f073122018-11-27 15:58:47 +01005129component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005130 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005131 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005132 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005133 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005134}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005135
Gilles Peskinecf740502019-07-03 20:43:05 +02005136component_test_cmake_shared () {
5137 msg "build/test: cmake shared" # ~ 2min
5138 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5139 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005140 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005141 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005142 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005143}
5144
Gilles Peskineec10bf12019-09-20 19:56:06 +02005145test_build_opt () {
5146 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005147 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005148 for opt in "$@"; do
5149 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005150 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005151 # We're confident enough in compilers to not run _all_ the tests,
5152 # but at least run the unit tests. In particular, runs with
5153 # optimizations use inline assembly whereas runs with -O0
5154 # skip inline assembly.
5155 make test # ~30s
5156 make clean
5157 done
5158}
5159
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005160# For FreeBSD we invoke the function by name so this condition is added
5161# to disable the existing test_clang_opt function for linux.
5162if [[ $(uname) != "Linux" ]]; then
5163 component_test_clang_opt () {
5164 scripts/config.py full
5165 test_build_opt 'full config' clang -O0 -Os -O2
5166 }
5167fi
5168
5169component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005170 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005171 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005172}
5173support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005174 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005175}
5176
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005177component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005178 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005179 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005180}
5181support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005182 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005183}
5184
5185component_test_gcc_latest_opt () {
5186 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005187 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005188}
5189support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005190 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005191}
5192
5193component_test_gcc_earliest_opt () {
5194 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005195 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005196}
5197support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005198 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005199}
5200
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005201component_build_mbedtls_config_file () {
5202 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005203 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005204 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005205 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005206 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005207 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5208 make clean
5209
5210 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5211 # In the user config, disable one feature (for simplicity, pick a feature
5212 # that nothing else depends on).
5213 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005214 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005215 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5216
5217 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005218}
5219
Gilles Peskine7d904e72022-04-07 21:59:14 +02005220component_build_psa_config_file () {
5221 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5222 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5223 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5224 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5225 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005226 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005227 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5228 make clean
5229
5230 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005231 # In the user config, disable one feature and its dependencies, which will
5232 # reflect on the mbedtls configuration so we can query it with
5233 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005234 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005235 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005236 scripts/config.py unset MBEDTLS_CMAC_C
5237 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5238 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5239
5240 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005241}
5242
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005243component_build_psa_alt_headers () {
5244 msg "build: make with PSA alt headers" # ~20s
5245
5246 # Generate alternative versions of the substitutable headers with the
5247 # same content except different include guards.
5248 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5249
5250 # Build the library and some programs.
5251 # Don't build the fuzzers to avoid having to go through hoops to set
5252 # a correct include path for programs/fuzz/Makefile.
5253 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
5254 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\"'"
5255
5256 # Check that we're getting the alternative include guards and not the
5257 # original include guards.
5258 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5259 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5260 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5261 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5262}
5263
Dave Rodgman852de3c2023-12-14 14:46:45 +00005264component_test_m32_no_asm () {
5265 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005266 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005267 #
5268 # Note that we require gcc, because clang Asan builds fail to link for
5269 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005270 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005271 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005272 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005273 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005274 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005275
Dave Rodgman852de3c2023-12-14 14:46:45 +00005276 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005277 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005278}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005279support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005280 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005281 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005282 *) false;;
5283 esac
5284}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005285
Gilles Peskineff0aee02021-10-05 09:36:03 +02005286component_test_m32_o2 () {
5287 # Build with optimization, to use the i386 specific inline assembly
5288 # and go faster for tests.
5289 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005290 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005291 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005292 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005293
Gilles Peskineff0aee02021-10-05 09:36:03 +02005294 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005295 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005296
Gilles Peskineff0aee02021-10-05 09:36:03 +02005297 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005298 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005299}
Gilles Peskinecf522222021-10-07 19:25:29 +02005300support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005301 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005302}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005303
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005304component_test_m32_everest () {
5305 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005306 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005307 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005308 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005309
5310 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5311 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005312
5313 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005314 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005315
5316 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5317 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005318 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005319}
5320support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005321 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005322}
5323
Gilles Peskine8f073122018-11-27 15:58:47 +01005324component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005325 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005326 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005327 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005328
5329 msg "test: 64-bit ILP32, make, gcc"
5330 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005331}
Gilles Peskine878cf602019-01-06 20:50:38 +00005332support_test_mx32 () {
5333 case $(uname -m) in
5334 amd64|x86_64) true;;
5335 *) false;;
5336 esac
5337}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005338
Peter Kolbus60c6da22018-12-27 06:59:04 -06005339component_test_min_mpi_window_size () {
5340 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005341 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005342 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005343 make
5344
5345 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5346 make test
5347}
5348
Gilles Peskine8f073122018-11-27 15:58:47 +01005349component_test_have_int32 () {
5350 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005351 scripts/config.py unset MBEDTLS_HAVE_ASM
5352 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005353 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005354 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005355
Gilles Peskine8f073122018-11-27 15:58:47 +01005356 msg "test: gcc, force 32-bit bignum limbs"
5357 make test
5358}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005359
Gilles Peskine8f073122018-11-27 15:58:47 +01005360component_test_have_int64 () {
5361 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005362 scripts/config.py unset MBEDTLS_HAVE_ASM
5363 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005364 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005365 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005366
Gilles Peskine8f073122018-11-27 15:58:47 +01005367 msg "test: gcc, force 64-bit bignum limbs"
5368 make test
5369}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005370
Gabor Mezeie256cc12023-07-26 17:28:48 +02005371component_test_have_int32_cmake_new_bignum () {
5372 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5373 scripts/config.py unset MBEDTLS_HAVE_ASM
5374 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005375 scripts/config.py unset MBEDTLS_AESCE_C
5376 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005377 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005378 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005379
5380 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5381 make test
5382}
5383
Gilles Peskine8f073122018-11-27 15:58:47 +01005384component_test_no_udbl_division () {
5385 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005386 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005387 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005388 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005389
Gilles Peskine8f073122018-11-27 15:58:47 +01005390 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5391 make test
5392}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005393
Gilles Peskine8f073122018-11-27 15:58:47 +01005394component_test_no_64bit_multiplication () {
5395 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005396 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005397 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005398 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005399
Gilles Peskine8f073122018-11-27 15:58:47 +01005400 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5401 make test
5402}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005403
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005404component_test_no_strings () {
5405 msg "build: no strings" # ~10s
5406 scripts/config.py full
5407 # Disable options that activate a large amount of string constants.
5408 scripts/config.py unset MBEDTLS_DEBUG_C
5409 scripts/config.py unset MBEDTLS_ERROR_C
5410 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5411 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005412 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005413
5414 msg "test: no strings" # ~ 10s
5415 make test
5416}
5417
Hanno Beckerc5722d12020-10-09 11:10:42 +01005418component_test_no_x509_info () {
5419 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5420 scripts/config.pl full
5421 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5422 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005423 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005424
5425 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5426 make test
5427
5428 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005429 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005430}
5431
Gilles Peskine8f073122018-11-27 15:58:47 +01005432component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005433 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005434 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005435 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 +02005436
Gilles Peskinee36fe812021-09-01 20:00:33 +02005437 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005438 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005439}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005440
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005441component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005442 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005443 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005444 # Build for a target platform that's close to what Debian uses
5445 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005446 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005447 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005448 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005449 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'
5450
Gilles Peskinee36fe812021-09-01 20:00:33 +02005451 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005452 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005453}
5454support_build_arm_linux_gnueabi_gcc_arm5vte () {
5455 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5456}
5457
5458component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005459 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005460 scripts/config.py baremetal
5461 # This is an imperfect substitute for
5462 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005463 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005464 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 +02005465
Gilles Peskinee36fe812021-09-01 20:00:33 +02005466 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005467 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005468}
5469
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005470component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005471 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5472 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005473 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 +02005474
Gilles Peskinee36fe812021-09-01 20:00:33 +02005475 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005476 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005477 for lib in library/*.a; do
5478 echo "$lib:"
5479 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5480 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005481}
5482
Gilles Peskine8f073122018-11-27 15:58:47 +01005483component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005484 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005485 scripts/config.py baremetal
5486 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005487 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 +01005488 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005489 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005490}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005491
Gilles Peskine8f073122018-11-27 15:58:47 +01005492component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005493 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005494 scripts/config.py baremetal
5495 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005496 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 +01005497 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005498 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005499}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005500
Dave Rodgman8c315f22023-06-02 10:26:24 -04005501component_build_arm_clang_thumb () {
5502 # ~ 30s
5503
5504 scripts/config.py baremetal
5505
5506 msg "build: clang thumb 2, make"
5507 make clean
5508 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5509
5510 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5511 msg "build: clang thumb 1 -O0, make"
5512 make clean
5513 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5514
5515 msg "build: clang thumb 1 -Os, make"
5516 make clean
5517 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5518}
5519
Gilles Peskine8f073122018-11-27 15:58:47 +01005520component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005521 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005522 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005523 # armc[56] don't support SHA-512 intrinsics
5524 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005525
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005526 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5527 scripts/config.py unset MBEDTLS_AESCE_C
5528
Dave Rodgman0fddf822023-03-02 15:32:12 +00005529 # Stop armclang warning about feature detection for A64_CRYPTO.
5530 # With this enabled, the library does build correctly under armclang,
5531 # but in baremetal builds (as tested here), feature detection is
5532 # unavailable, and the user is notified via a #warning. So enabling
5533 # this feature would prevent us from building with -Werror on
5534 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005535 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005536
Hanno Beckerf0762e92022-07-15 12:08:19 +01005537 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005538
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005539 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005540
5541 msg "size: ARM Compiler 5"
5542 "$ARMC5_FROMELF" -z library/*.o
5543
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005544 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005545
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005546 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005547 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005548
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005549 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005550 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5551
5552 # ARM Compiler 6 - Target ARMv7-M+DSP
5553 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005554
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005555 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005556 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005557
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005558 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005559 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005560
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005561 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5562 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5563
Dave Rodgman99318e62023-05-24 12:27:42 +01005564 # ARM Compiler 6 - Target Cortex-M0
5565 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005566
5567 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5568 #
5569 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5570 # that we have in our CI
5571 scripts/config.py set MBEDTLS_AESCE_C
5572 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005573}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005574
Pengyu Lvdf070032023-02-24 16:03:31 +08005575support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005576 armc5_cc="$ARMC5_BIN_DIR/armcc"
5577 armc6_cc="$ARMC6_BIN_DIR/armclang"
5578 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005579}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005580
Ronald Crond2cb7f42024-03-18 12:49:18 +01005581component_test_tls12_only () {
5582 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5583 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5584 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5585 make
5586
5587 msg "test: main suites (inc. selftests) (ASan build)"
5588 make test
5589
5590 msg "test: ssl-opt.sh (ASan build)"
5591 tests/ssl-opt.sh
5592
5593 msg "test: compat.sh (ASan build)"
5594 tests/compat.sh
5595}
5596
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005597component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005598 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005599 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005600 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005601 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5602
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005603 msg "test: TLS 1.3 only, all key exchange modes enabled"
5604 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005605
Ronald Cronc3f43b62022-10-17 17:35:32 +02005606 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5607 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005608}
5609
Ronald Cronc3f43b62022-10-17 17:35:32 +02005610component_test_tls13_only_psk () {
5611 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5612 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5613 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5614 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005615 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005616 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5617 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5618 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5619 scripts/config.py unset MBEDTLS_ECDSA_C
5620 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005621 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005622 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005623 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5624
Ronald Cronc3f43b62022-10-17 17:35:32 +02005625 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5626 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005627
Ronald Cronc3f43b62022-10-17 17:35:32 +02005628 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5629 tests/ssl-opt.sh
5630}
5631
5632component_test_tls13_only_ephemeral () {
5633 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5634 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5635 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005636 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005637 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5638
5639 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5640 cd tests; ./test_suite_ssl; cd ..
5641
5642 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5643 tests/ssl-opt.sh
5644}
5645
Przemek Stekiela01c2422023-06-13 10:46:48 +02005646component_test_tls13_only_ephemeral_ffdh () {
5647 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5648 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5649 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5650 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005651 scripts/config.py unset MBEDTLS_ECDH_C
5652
Przemek Stekiela01c2422023-06-13 10:46:48 +02005653 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5654
5655 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5656 cd tests; ./test_suite_ssl; cd ..
5657
5658 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5659 tests/ssl-opt.sh
5660}
5661
Ronald Cronc3f43b62022-10-17 17:35:32 +02005662component_test_tls13_only_psk_ephemeral () {
5663 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5664 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5665 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5666 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5667 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5668 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5669 scripts/config.py unset MBEDTLS_ECDSA_C
5670 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005671 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005672 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005673 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5674
5675 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5676 cd tests; ./test_suite_ssl; cd ..
5677
5678 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5679 tests/ssl-opt.sh
5680}
5681
Przemek Stekiela01c2422023-06-13 10:46:48 +02005682component_test_tls13_only_psk_ephemeral_ffdh () {
5683 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5684 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5685 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5686 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5687 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5688 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5689 scripts/config.py unset MBEDTLS_ECDSA_C
5690 scripts/config.py unset MBEDTLS_PKCS1_V21
5691 scripts/config.py unset MBEDTLS_PKCS7_C
5692 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005693 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005694 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5695
5696 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5697 cd tests; ./test_suite_ssl; cd ..
5698
5699 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5700 tests/ssl-opt.sh
5701}
5702
Ronald Cronc3f43b62022-10-17 17:35:32 +02005703component_test_tls13_only_psk_all () {
5704 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5705 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5706 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5707 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5708 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5709 scripts/config.py unset MBEDTLS_ECDSA_C
5710 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005711 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005712 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005713 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5714
5715 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5716 cd tests; ./test_suite_ssl; cd ..
5717
5718 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5719 tests/ssl-opt.sh
5720}
5721
5722component_test_tls13_only_ephemeral_all () {
5723 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5724 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005725 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005726 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5727
5728 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5729 cd tests; ./test_suite_ssl; cd ..
5730
5731 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5732 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005733}
5734
Ronald Cron46ac0652024-03-18 12:39:04 +01005735component_test_tls13_no_padding () {
5736 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005737 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005738 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005739 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005740 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005741 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005742 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005743 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005744 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005745}
5746
Ronald Cron6f135e12021-12-08 16:57:54 +01005747component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005748 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005749 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005750 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005751 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005752 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005753 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005754 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005755 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005756 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005757}
5758
Ronald Crondd96c0a2024-04-02 12:34:24 +02005759component_test_full_minus_session_tickets() {
5760 msg "build: full config without session tickets"
5761 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005762 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005763 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005764 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5765 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005766 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005767 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005768 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005769 tests/ssl-opt.sh
5770}
5771
Gilles Peskine8f073122018-11-27 15:58:47 +01005772component_build_mingw () {
5773 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005774 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 +00005775
Gilles Peskine8f073122018-11-27 15:58:47 +01005776 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005777 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 +01005778 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005779
Gilles Peskine8f073122018-11-27 15:58:47 +01005780 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005781 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
5782 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 +01005783 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005784
Pengyu Lv158eead2023-10-19 11:27:05 +08005785 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005786 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005787 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 +01005788 make WINDOWS_BUILD=1 clean
5789}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005790support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005791 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5792 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005793 *) true;;
5794 esac
5795}
Simon Butcher91aef332016-11-17 09:20:50 +00005796
Gilles Peskine8f073122018-11-27 15:58:47 +01005797component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005798 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005799 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005800 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5801 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005802
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005803 msg "test: main suites (MSan)" # ~ 10s
5804 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005805
Gilles Peskine6848d172023-11-02 19:58:03 +01005806 msg "test: metatests (MSan)"
5807 tests/scripts/run-metatests.sh any msan
5808
Gilles Peskine82b27272019-06-14 18:27:03 +02005809 msg "program demos (MSan)" # ~20s
5810 tests/scripts/run_demos.py
5811
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005812 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005813 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005814
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005815 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005816
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005817 if [ "$MEMORY" -gt 0 ]; then
5818 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005819 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005820 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005821}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005822
Bence Szépkúti0354d042023-12-06 16:14:37 +01005823component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005824 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005825 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005826 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5827 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005828
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005829 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005830 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005831
Gilles Peskine636c26a2020-03-04 20:46:15 +01005832 # Optional parts (slow; currently broken on OS X because programs don't
5833 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005834 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005835 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005836 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005837 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005838 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005839
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005840 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005841 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005842 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005843 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005844
5845 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005846 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005847 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005848 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005849}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005850
Bence Szépkúti0354d042023-12-06 16:14:37 +01005851component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005852 msg "build: Release, full (clang)"
5853 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5854 scripts/config.py full
5855 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5856 make
5857
5858 msg "test: main suites, Valgrind (full config)"
5859 make memcheck
5860}
5861
Paul Elliott62dc3922021-11-25 17:29:40 +00005862support_test_cmake_out_of_source () {
5863 distrib_id=""
5864 distrib_ver=""
5865 distrib_ver_minor=""
5866 distrib_ver_major=""
5867
5868 # Attempt to parse lsb-release to find out distribution and version. If not
5869 # found this should fail safe (test is supported).
5870 if [[ -f /etc/lsb-release ]]; then
5871
5872 while read -r lsb_line; do
5873 case "$lsb_line" in
5874 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5875 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5876 esac
5877 done < /etc/lsb-release
5878
5879 distrib_ver_major="${distrib_ver%%.*}"
5880 distrib_ver="${distrib_ver#*.}"
5881 distrib_ver_minor="${distrib_ver%%.*}"
5882 fi
5883
5884 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5885 # processor (as the CI does) can create a race condition whereby the build
5886 # fails to see a generated file, despite that file actually having been
5887 # generated. This problem appears to go away with 18.04 or newer, so make
5888 # the out of source tests unsupported on Ubuntu 16.04.
5889 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5890}
5891
Gilles Peskine8f073122018-11-27 15:58:47 +01005892component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005893 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005894 # generates
5895 make neat
5896
Gilles Peskine8f073122018-11-27 15:58:47 +01005897 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005898 MBEDTLS_ROOT_DIR="$PWD"
5899 mkdir "$OUT_OF_SOURCE_DIR"
5900 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005901 # Note: Explicitly generate files as these are turned off in releases
5902 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005903 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005904
Gilles Peskine8f073122018-11-27 15:58:47 +01005905 msg "test: cmake 'out-of-source' build"
5906 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005907 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005908 # Also ensure that there are no error messages such as
5909 # "No such file or directory", which would indicate that some required
5910 # file is missing (ssl-opt.sh tolerates the absence of some files so
5911 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005912 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005913 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005914 cat ssl-opt.err >&2
5915 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005916 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005917 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005918 cd "$MBEDTLS_ROOT_DIR"
5919 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005920}
Andres AGdc192212016-08-31 17:33:13 +01005921
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005922component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005923 # Remove existing generated files so that we use the ones CMake
5924 # generates
5925 make neat
5926
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005927 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005928 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005929 # Note: Explicitly generate files as these are turned off in releases
5930 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005931 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005932 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005933}
Gilles Peskinea3000992022-02-04 00:21:12 +01005934support_test_cmake_as_subdirectory () {
5935 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005936}
5937
Chris Kayd259e342021-03-25 16:03:25 +00005938component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005939 # Remove existing generated files so that we use the ones CMake
5940 # generates
5941 make neat
5942
Chris Kayd259e342021-03-25 16:03:25 +00005943 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005944 cd programs/test/cmake_package
5945 cmake .
5946 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005947 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005948}
Gilles Peskinea3000992022-02-04 00:21:12 +01005949support_test_cmake_as_package () {
5950 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005951}
5952
5953component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005954 # Remove existing generated files so that we use the ones CMake
5955 # generates
5956 make neat
5957
Chris Kayd259e342021-03-25 16:03:25 +00005958 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005959 cd programs/test/cmake_package_install
5960 cmake .
5961 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005962 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005963}
Gilles Peskinea3000992022-02-04 00:21:12 +01005964support_test_cmake_as_package_install () {
5965 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005966}
5967
David Horstmann20550e32023-01-12 14:17:01 +00005968component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005969 # Make a copy of config file to use for the in-tree test
5970 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005971
5972 MBEDTLS_ROOT_DIR="$PWD"
5973 mkdir "$OUT_OF_SOURCE_DIR"
5974 cd "$OUT_OF_SOURCE_DIR"
5975
David Horstmann969c1452023-01-31 10:34:44 +00005976 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005977 cmake "$MBEDTLS_ROOT_DIR"
5978 make
5979
5980 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5981 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005982 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005983 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5984 make
5985
5986 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5987 # In the user config, disable one feature (for simplicity, pick a feature
5988 # that nothing else depends on).
5989 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5990
5991 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5992 make
5993 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5994
5995 rm -f user_config.h full_config.h
5996
5997 cd "$MBEDTLS_ROOT_DIR"
5998 rm -rf "$OUT_OF_SOURCE_DIR"
5999
6000 # Now repeat the test for an in-tree build:
6001
David Horstmann969c1452023-01-31 10:34:44 +00006002 # Restore config for the in-tree test
6003 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006004
David Horstmann969c1452023-01-31 10:34:44 +00006005 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006006 cmake .
6007 make
6008
6009 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6010 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006011 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006012 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6013 make
6014
6015 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6016 # In the user config, disable one feature (for simplicity, pick a feature
6017 # that nothing else depends on).
6018 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6019
6020 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6021 make
6022 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6023
6024 rm -f user_config.h full_config.h
6025}
6026support_build_cmake_custom_config_file () {
6027 support_test_cmake_out_of_source
6028}
6029
David Horstmann041ed422024-05-10 14:37:48 +01006030component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006031 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006032 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6033 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6034 make
6035}
6036support_build_cmake_programs_no_testing () {
6037 support_test_cmake_out_of_source
6038}
David Horstmann20550e32023-01-12 14:17:01 +00006039
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006040component_build_zeroize_checks () {
6041 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6042
6043 scripts/config.py full
6044
6045 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006046 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 +01006047}
6048
6049
Gilles Peskine8f073122018-11-27 15:58:47 +01006050component_test_zeroize () {
6051 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6052 # different combinations of compilers and optimization flags by using an
6053 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6054 # system in all cases that the script fails, so we must manually search the
6055 # output to check whether the pass string is present and no failure strings
6056 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006057
Gilles Peskine4976e822019-01-06 19:52:22 +00006058 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6059 # about a spurious message if Gdb tries and fails, so suppress that.
6060 gdb_disable_aslr=
6061 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6062 gdb_disable_aslr='set disable-randomization off'
6063 fi
6064
Gilles Peskine8f073122018-11-27 15:58:47 +01006065 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006066 for compiler in clang gcc; do
6067 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6068 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006069 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6070 grep "The buffer was correctly zeroized" test_zeroize.log
6071 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006072 rm -f test_zeroize.log
6073 make clean
6074 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006075 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006076}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006077
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006078component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006079 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006080 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006081 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006082
6083 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006084 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006085}
6086
6087support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006088 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006089 ver="$(cmake --version)"
6090 ver="${ver#cmake version }"
6091 ver_major="${ver%%.*}"
6092
6093 ver="${ver#*.}"
6094 ver_minor="${ver%%.*}"
6095
6096 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006097}
6098
Gilles Peskinec848d222022-12-09 12:23:35 +01006099component_check_code_style () {
6100 msg "Check C code style"
6101 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006102}
6103
Gilles Peskinec848d222022-12-09 12:23:35 +01006104support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006105 case $(uncrustify --version) in
6106 *0.75.1*) true;;
6107 *) false;;
6108 esac
6109}
6110
Gilles Peskine8f073122018-11-27 15:58:47 +01006111component_check_python_files () {
6112 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006113 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006114}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006115
Joe Subbianid614c0b2021-07-29 11:18:29 +01006116component_check_test_helpers () {
6117 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006118 # unittest writes out mundane stuff like number or tests run on stderr.
6119 # Our convention is to reserve stderr for actual errors, and write
6120 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006121 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006122
Joe Subbiania25ffab2021-08-06 09:41:27 +01006123 msg "unit test: translate_ciphers.py"
6124 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006125}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006126
Valerio Settid9e42512024-05-06 15:59:51 +02006127component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006128 msg "build library for client"
6129
6130 helper_crypto_client_build client
6131
6132 msg "build library for server"
6133
6134 scripts/config.py crypto
6135
6136 helper_crypto_client_build server
6137
Valerio Settid9e42512024-05-06 15:59:51 +02006138 msg "build psasim"
Valerio Setti4362aae2024-05-09 09:15:39 +02006139 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Settid9e42512024-05-06 15:59:51 +02006140
6141 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006142 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006143
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006144 msg "build psasim to test psa_hash_compute"
6145 # Delete the executable to ensure we build using the right MAIN
6146 rm tests/psa-client-server/psasim/test/psa_client
6147 # API under test: psa_hash_compute()
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006148 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash_compute.c"
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006149
6150 msg "test psasim running psa_hash_compute"
6151 tests/psa-client-server/psasim/test/run_test.sh
6152
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006153 # Next APIs under test: psa_hash_*(). Just use the PSA hash example.
6154 aut_psa_hash="../../../programs/psa/psa_hash.c"
6155 if [ -f "tests/psa-client-server/psasim/$aut_psa_hash" ]; then
6156
6157 msg "build psasim to test all psa_hash_* APIs"
6158 # Delete the executable to ensure we build using the right MAIN
6159 rm tests/psa-client-server/psasim/test/psa_client
6160 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="$aut_psa_hash"
6161
6162 msg "test psasim running psa_hash sample"
6163 tests/psa-client-server/psasim/test/run_test.sh
6164 else
6165 echo $aut_psa_hash NOT FOUND, so not running that test
6166 fi
6167
Valerio Settid9e42512024-05-06 15:59:51 +02006168 msg "clean psasim"
6169 make -C tests/psa-client-server/psasim clean
6170}
Jerry Yud767cc42023-03-31 15:03:55 +08006171
Gilles Peskine192c72f2017-12-21 15:59:21 +01006172################################################################
6173#### Termination
6174################################################################
6175
Gilles Peskine8f073122018-11-27 15:58:47 +01006176post_report () {
6177 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006178 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006179
Gilles Peskine8f073122018-11-27 15:58:47 +01006180 final_report
6181}
6182
6183
6184
6185################################################################
6186#### Run all the things
6187################################################################
6188
Gilles Peskine5d996822020-03-28 21:09:21 +01006189# Function invoked by --error-test to test error reporting.
6190pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006191 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006192 if [ $KEEP_GOING -ne 0 ]; then
6193 echo "Expect three failing commands."
6194 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006195 # If the component doesn't run in a subshell, changing error_test_i to an
6196 # invalid integer will cause an error in the loop that runs this function.
6197 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006198 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006199 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006200 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006201 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006202 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006203 make unknown_target
6204 false "this should not be executed"
6205}
6206
Gilles Peskinee48351a2018-11-27 16:06:30 +01006207# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006208run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006209 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006210 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006211
6212 # Unconditionally create a seedfile that's sufficiently long.
6213 # Do this before each component, because a previous component may
6214 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006215 local dd_cmd
6216 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6217 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006218 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006219 esac
6220 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006221
Gilles Peskineec135542021-08-02 23:14:03 +02006222 # Run the component in a subshell, with error trapping and output
6223 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006224 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006225 # We want to keep running if the subshell fails, so 'set -e' must
6226 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006227 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006228 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006229 (
6230 if [ $QUIET -eq 1 ]; then
6231 # msg() will be silenced, so just print the component name here.
6232 echo "${current_component#component_}"
6233 exec >/dev/null
6234 fi
6235 if [ $KEEP_GOING -eq 1 ]; then
6236 # Keep "set -e" off, and run an ERR trap instead to record failures.
6237 set -E
6238 trap err_trap ERR
6239 fi
6240 # The next line is what runs the component
6241 "$@"
6242 if [ $KEEP_GOING -eq 1 ]; then
6243 trap - ERR
6244 exit $last_failure_status
6245 fi
6246 )
6247 component_status=$?
6248 if [ $KEEP_GOING -eq 1 ]; then
6249 set -e
6250 if [ $component_status -ne 0 ]; then
6251 failure_count=$((failure_count + 1))
6252 fi
6253 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006254
6255 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006256 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006257 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006258}
6259
6260# Preliminary setup
6261pre_check_environment
6262pre_initialize_variables
6263pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006264
Dave Rodgman21900632024-02-26 11:41:19 +00006265setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006266pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006267pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006268pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006269
Gilles Peskine878cf602019-01-06 20:50:38 +00006270build_status=0
6271if [ $KEEP_GOING -eq 1 ]; then
6272 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006273fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006274pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006275pre_print_configuration
6276pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006277cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006278if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006279 pre_generate_files
6280fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006281
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006282# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006283for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006284 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006285done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006286unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006287for component in $RUN_COMPONENTS; do
6288 run_component "component_$component"
6289done
Gilles Peskine8f073122018-11-27 15:58:47 +01006290
6291# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006292post_report