blob: b12a86fa92f55d8483093bfd2e460230a0c78fcc [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cron561181c2024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100136 else
137 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100138 fi
John Durkopbd069d32020-10-31 22:14:03 -0700139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100140 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200141
142 # Files that are clobbered by some jobs will be backed up. Use a different
143 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
144 # independently decide when to remove the backup file.
145 backup_suffix='.all.bak'
146 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100147 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100148 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 # Files clobbered by in-tree cmake
150 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
151 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200152
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200153 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100154 MEMORY=0
155 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200156 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100158
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200159 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200160 #
161 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
162 # both values are kept in sync. If you change the value here because it
163 # breaks some tests, you'll definitely want to change it in
164 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200165 RELEASE_SEED=1
166
Yanray Wang18040ed2023-11-23 21:29:56 +0800167 # Specify character collation for regular expressions and sorting with C locale
168 export LC_COLLATE=C
169
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200170 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200171 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200172 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200173 export MBEDTLS_TEST_PLATFORM
174
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000175 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL_NEXT:="$OPENSSL"}
178 : ${GNUTLS_CLI:="gnutls-cli"}
179 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100180 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
181 : ${ARMC5_BIN_DIR:=/usr/bin}
182 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200183 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200184 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100185 : ${CLANG_LATEST:="clang-latest"}
186 : ${CLANG_EARLIEST:="clang-earliest"}
187 : ${GCC_LATEST:="gcc-latest"}
188 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000190 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200191 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100192 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000193 # if CC is not set, use clang by default (if present) to improve build times
194 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000195 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000196 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000197
Ronald Cron561181c2024-04-02 14:39:53 +0200198 if [ -n "${OPENSSL_3+set}" ]; then
199 export OPENSSL_NEXT="$OPENSSL_3"
200 fi
201
Gilles Peskine396853a2021-09-20 18:57:55 +0200202 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000203 export CTEST_OUTPUT_ON_FAILURE=1
204
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100206 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200207 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000208 # Normally, tests should use this compiler for ASAN testing
209 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200210
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400211 # Platform tests have an allocation that returns null
212 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400213 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400214
Gilles Peskine878cf602019-01-06 20:50:38 +0000215 # Gather the list of available components. These are the functions
216 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100217 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000218
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000219 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100220 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100221}
Andres AG38495a32016-07-12 16:54:33 +0100222
Dave Rodgman21900632024-02-26 11:41:19 +0000223setup_quiet_wrappers()
224{
225 # Pick up "quiet" wrappers for make and cmake, which don't output very much
226 # unless there is an error. This reduces logging overhead in the CI.
227 #
228 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000229 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
230 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000231 fi
232}
233
Gilles Peskinea28db922019-01-10 00:05:18 +0100234# Test whether the component $1 is included in the command line patterns.
235is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100236{
Gilles Peskine03af6782021-08-06 11:35:17 +0200237 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
238 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000240 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100241 set +f
242 case ${1#component_} in $pattern) return 0;; esac
243 done
244 set +f
245 return 1
246}
Andres AG7770ea82016-10-10 15:46:20 +0100247
Simon Butcher41eeccf2016-09-07 00:07:09 +0100248usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100249{
Gilles Peskine709346a2017-12-10 23:43:39 +0100250 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100251Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100252Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100253By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100254COMPONENT can be the name of a component or a shell wildcard pattern.
255
256Examples:
257 $0 "check_*"
258 Run all sanity checks.
259 $0 --no-armcc --except test_memsan
260 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100261
262Special options:
263 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000264 --list-all-components List all available test components and exit.
265 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100266
267General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200268 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100270 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100271 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200272 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200273 --arm-none-eabi-gcc-prefix=<string>
274 Prefix for a cross-compiler for arm-none-eabi
275 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200276 --arm-linux-gnueabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-linux-gnueabi
278 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100279 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200280 --restore First clean up the build tree, restoring backed up
281 files. Do not run any components unless they are
282 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100283 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200284 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100285 --except Exclude the COMPONENTs listed on the command line,
286 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200287 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100288 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100289 --no-force Refuse to overwrite modified files (default).
290 --no-keep-going Stop at the first error (default).
291 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800292 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100293 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --outcome-file=<path> File where test outcomes are written (not done if
295 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200297 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100298 -s|--seed Integer seed value to use for this test run.
299
300Tool path options:
301 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
302 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100303 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
304 --clang-latest=<Clang_latest_path> Latest version of clang available
305 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
306 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100307 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
308 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100310 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100311EOF
SimonB2e23c822016-04-16 21:54:39 +0100312}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200314# Cleanup before/after running a component.
315# Remove built files as well as the cmake cache/config.
316# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100317cleanup()
318{
David Horstmann76a77382023-08-17 17:32:26 +0100319 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100320 command make clean
321 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200322
Gilles Peskine31b07e22018-03-21 12:15:06 +0100323 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000324 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100325 -iname CMakeFiles -exec rm -rf {} \+ -o \
326 \( -iname cmake_install.cmake -o \
327 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200328 -iname CMakeCache.txt -o \
329 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200331 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200332
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100333 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
334 rm -rf programs/test/cmake_subproject/build
335 rm -f programs/test/cmake_subproject/Makefile
336 rm -f programs/test/cmake_subproject/cmake_subproject
337
Chris Kayd259e342021-03-25 16:03:25 +0000338 # Remove any artifacts from the component_test_cmake_as_package test.
339 rm -rf programs/test/cmake_package/build
340 rm -f programs/test/cmake_package/Makefile
341 rm -f programs/test/cmake_package/cmake_package
342
343 # Remove any artifacts from the component_test_cmake_as_installed_package test.
344 rm -rf programs/test/cmake_package_install/build
345 rm -f programs/test/cmake_package_install/Makefile
346 rm -f programs/test/cmake_package_install/cmake_package_install
347
Gilles Peskinef83eb822020-03-30 20:11:39 +0200348 # Restore files that may have been clobbered by the job
349 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200350 if [[ -e "$x$backup_suffix" ]]; then
351 cp -p "$x$backup_suffix" "$x"
352 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 done
354}
John Durkopbd069d32020-10-31 22:14:03 -0700355
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200356# Final cleanup when this script exits (except when exiting on a failure
357# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358final_cleanup () {
359 cleanup
360
361 for x in $files_to_back_up; do
362 rm -f "$x$backup_suffix"
363 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100364}
365
Gilles Peskine7c652162017-12-11 00:01:40 +0100366# Executed on exit. May be redefined depending on command line options.
367final_report () {
368 :
369}
370
371fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200372 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100373 final_report $1
374 trap - $1
375 kill -$1 $$
376}
377
378trap 'fatal_signal HUP' HUP
379trap 'fatal_signal INT' INT
380trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200381
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200382# Number of processors on this machine. Used as the default setting
383# for parallel make.
384all_sh_nproc ()
385{
386 {
387 nproc || # Linux
388 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
389 sysctl -n hw.ncpu || # FreeBSD
390 echo 1
391 } 2>/dev/null
392}
393
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100394msg()
395{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100396 if [ -n "${current_component:-}" ]; then
397 current_section="${current_component#component_}: $1"
398 else
399 current_section="$1"
400 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200401
402 if [ $QUIET -eq 1 ]; then
403 return
404 fi
405
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo ""
407 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100408 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000409 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100410 echo "******************************************************************"
411}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100412
Gilles Peskine8f073122018-11-27 15:58:47 +0100413armc6_build_test()
414{
415 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100416
Gilles Peskine18487f62020-04-30 23:11:54 +0200417 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800418 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100419 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000420 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200421
422 msg "size: ARM Compiler 6 ($FLAGS)"
423 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100424}
Andres AGa5cd9732016-10-17 15:23:10 +0100425
Andres AGd9eba4b2016-08-26 14:42:14 +0100426err_msg()
427{
428 echo "$1" >&2
429}
430
431check_tools()
432{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200433 for tool in "$@"; do
434 if ! `type "$tool" >/dev/null 2>&1`; then
435 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100436 exit 1
437 fi
438 done
439}
440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000442 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100443 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100444 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100445 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200446 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000447 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100448
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000449 # Note that legacy options are ignored instead of being omitted from this
450 # list of options, so invocations that worked with previous version of
451 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100452 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100453 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200454 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200455 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200456 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000457 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100458 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
459 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100460 --clang-earliest) shift; CLANG_EARLIEST="$1";;
461 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100462 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000463 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100464 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100465 --gcc-earliest) shift; GCC_EARLIEST="$1";;
466 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200468 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
469 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-serv) shift; GNUTLS_SERV="$1";;
471 --help|-h) usage; exit;;
472 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000473 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100474 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200476 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000477 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --no-force) FORCE=0;;
479 --no-keep-going) KEEP_GOING=0;;
480 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200481 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100482 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200486 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200488 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200489 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --seed|-s) shift; SEED="$1";;
491 -*)
492 echo >&2 "Unknown option: $1"
493 echo >&2 "Run $0 --help for usage."
494 exit 120
495 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000496 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 esac
498 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100499 done
SimonB2e23c822016-04-16 21:54:39 +0100500
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100501 # Exclude components that are not supported on this platform.
502 SUPPORTED_COMPONENTS=
503 for component in $ALL_COMPONENTS; do
504 case $(type "support_$component" 2>&1) in
505 *' function'*)
506 if ! support_$component; then continue; fi;;
507 esac
508 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
509 done
510
511 if [ $list_components -eq 1 ]; then
512 printf '%s\n' $SUPPORTED_COMPONENTS
513 exit
514 fi
515
Gilles Peskinea28db922019-01-10 00:05:18 +0100516 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200517 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000518 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100519 fi
520
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000521 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
522 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100523 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100525 fi
SimonB2e23c822016-04-16 21:54:39 +0100526
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200527 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 if [ $all_except -eq 0 ]; then
529 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200530 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
531 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200532 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200534 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200535 # If the requested name includes a wildcard character, don't
536 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100537 case $component in
538 *[*?\[]*) continue;;
539 esac
540 case " $SUPPORTED_COMPONENTS " in
541 *" $component "*) :;;
542 *)
543 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
544 unsupported=$((unsupported + 1));;
545 esac
546 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200547 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100548 if [ $unsupported -ne 0 ]; then
549 exit 2
550 fi
551 fi
552
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000553 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100554 RUN_COMPONENTS=
555 for component in $SUPPORTED_COMPONENTS; do
556 if is_component_included "$component"; [ $? -eq $all_except ]; then
557 RUN_COMPONENTS="$RUN_COMPONENTS $component"
558 fi
559 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560
561 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000562 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100563}
SimonB2e23c822016-04-16 21:54:39 +0100564
Gilles Peskine8f073122018-11-27 15:58:47 +0100565pre_check_git () {
566 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100567 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 git checkout-index -f -q $CONFIG_H
569 cleanup
570 else
SimonB2e23c822016-04-16 21:54:39 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
573 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
574 echo "You can either delete this directory manually, or force the test by rerunning"
575 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
576 exit 1
577 fi
578
Ronald Cron7a93ac52023-07-20 09:49:12 +0200579 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100580 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100581 echo "You can either delete or preserve your work, or force the test by rerunning the"
582 echo "script as: $0 --force"
583 exit 1
584 fi
SimonB2e23c822016-04-16 21:54:39 +0100585 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500586}
587
Gilles Peskine568f53a2021-07-12 18:16:01 +0200588pre_restore_files () {
589 # If the makefiles have been generated by a framework such as cmake,
590 # restore them from git. If the makefiles look like modifications from
591 # the ones checked into git, take care not to modify them. Whatever
592 # this function leaves behind is what the script will restore before
593 # each component.
594 case "$(head -n1 Makefile)" in
595 *[Gg]enerated*)
596 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
597 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
598 ;;
599 esac
600}
601
Gilles Peskinef83eb822020-03-30 20:11:39 +0200602pre_back_up () {
603 for x in $files_to_back_up; do
604 cp -p "$x" "$x$backup_suffix"
605 done
606}
607
Gilles Peskine8f073122018-11-27 15:58:47 +0100608pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100609 failure_count=0 # Number of failed components
610 last_failure_status=0 # Last failure status in this component
611
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100612 # See err_trap
613 previous_failure_status=0
614 previous_failed_command=
615 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100616 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100617
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 start_red=
619 end_color=
620 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100621 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100622 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
623 start_red=$(printf '\033[31m')
624 end_color=$(printf '\033[0m')
625 ;;
626 esac
627 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100628
629 # Keep a summary of failures in a file. We'll print it out at the end.
630 failure_summary_file=$PWD/all-sh-failures-$$.log
631 : >"$failure_summary_file"
632
633 # Whether it makes sense to keep a component going after the specified
634 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200635 # This function normally receives the failing simple command
636 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
637 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200639 # False positives result in running things that can't be expected to
640 # work. False negatives result in things not running after something else
641 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100642 can_keep_going_after_failure () {
643 case "$1" in
644 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200645 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100646 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200647 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
648 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
649 *make*check*) true;;
650 "grep "*) true;;
651 "[ "*) true;;
652 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100653 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100654 esac
655 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100656
657 # This function runs if there is any error in a component.
658 # It must either exit with a nonzero status, or set
659 # last_failure_status to a nonzero value.
660 err_trap () {
661 # Save $? (status of the failing command). This must be the very
662 # first thing, before $? is overridden.
663 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100664 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100665
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100666 if [[ $last_failure_status -eq $previous_failure_status &&
667 "$failed_command" == "$previous_failed_command" &&
668 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
669 then
670 # The same command failed twice in a row, but this time one level
671 # less deep in the function call stack. This happens when the last
672 # command of a function returns a nonzero status, and the function
673 # returns that same status. Ignore the second failure.
674 previous_failure_funcall_depth=${#FUNCNAME[@]}
675 return
676 fi
677 previous_failure_status=$last_failure_status
678 previous_failed_command=$failed_command
679 previous_failure_funcall_depth=${#FUNCNAME[@]}
680
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 text="$current_section: $failed_command -> $last_failure_status"
682 echo "${start_red}^^^^$text^^^^${end_color}" >&2
683 echo "$text" >>"$failure_summary_file"
684
685 # If the command is fatal (configure or build command), stop this
686 # component. Otherwise (test command) keep the component running
687 # (run more tests from the same build).
688 if ! can_keep_going_after_failure "$failed_command"; then
689 exit $last_failure_status
690 fi
691 }
692
Gilles Peskine7c652162017-12-11 00:01:40 +0100693 final_report () {
694 if [ $failure_count -gt 0 ]; then
695 echo
696 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100697 echo "${start_red}FAILED: $failure_count components${end_color}"
698 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
700 elif [ -z "${1-}" ]; then
701 echo "SUCCESS :)"
702 fi
703 if [ -n "${1-}" ]; then
704 echo "Killed by SIG$1."
705 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 rm -f "$failure_summary_file"
707 if [ $failure_count -gt 0 ]; then
708 exit 1
709 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100710 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100711}
712
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200713# record_status() and if_build_succeeded() are kept temporarily for backward
714# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100715record_status () {
716 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100717}
Gilles Peskine7c652162017-12-11 00:01:40 +0100718if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
721
Gilles Peskinea681c592020-03-28 21:27:40 +0100722# '! true' does not trigger the ERR trap. Arrange to trigger it, with
723# a reasonably informative error message (not just "$@").
724not () {
725 if "$@"; then
726 report_failed_command="! $*"
727 false
728 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200729 fi
730}
731
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200732pre_prepare_outcome_file () {
733 case "$MBEDTLS_TEST_OUTCOME_FILE" in
734 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
735 esac
736 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
737 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
738 fi
739}
740
Gilles Peskine8f073122018-11-27 15:58:47 +0100741pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200742 if [ $QUIET -eq 1 ]; then
743 return
744 fi
745
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 msg "info: $0 configuration"
747 echo "MEMORY: $MEMORY"
748 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200749 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100750 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100751 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
754 echo "GNUTLS_CLI: $GNUTLS_CLI"
755 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
757 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
758}
Andres AG7770ea82016-10-10 15:46:20 +0100759
Andres AGd9eba4b2016-08-26 14:42:14 +0100760# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100761pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000762 # Build the list of variables to pass to output_env.sh.
763 set env
SimonB2e23c822016-04-16 21:54:39 +0100764
Gilles Peskine87964262019-01-06 22:40:00 +0000765 case " $RUN_COMPONENTS " in
766 # Require OpenSSL and GnuTLS if running any tests (as opposed to
767 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
768 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100769 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000770 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
771 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100772 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000773 export GNUTLS_CLI="$GNUTLS_CLI"
774 export GNUTLS_SERV="$GNUTLS_SERV"
775 # Avoid passing --seed flag in every call to ssl-opt.sh
776 if [ -n "${SEED-}" ]; then
777 export SEED
778 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200779 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000780 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200781 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
782 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000783 ;;
784 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
787 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200791 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000792 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
796 esac
797
798 case " $RUN_COMPONENTS " in
799 *" test_zeroize "*) check_tools "gdb";;
800 esac
801
802 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000803 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000804 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
805 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200806 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
808 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
810 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
811 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000812 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000813
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200814 # past this point, no call to check_tool, only printing output
815 if [ $QUIET -eq 1 ]; then
816 return
817 fi
818
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000819 msg "info: output_env.sh"
820 case $RUN_COMPONENTS in
821 *_armcc*)
822 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
823 *) set "$@" RUN_ARMCC=0;;
824 esac
825 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100826}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100827
Gilles Peskine1570b592021-04-22 01:10:12 +0200828pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200829 # since make doesn't have proper dependencies, remove any possibly outdate
830 # file that might be around before generating fresh ones
831 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200832 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200833 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200834 else
835 make generated_files
836 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200837}
838
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000839clang_version() {
840 if command -v clang > /dev/null ; then
841 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
842 else
843 echo 0 # report version 0 for "no clang"
844 fi
845}
846
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200847################################################################
848#### Helpers for components using libtestdriver1
849################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100850
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200851# How to use libtestdriver1
852# -------------------------
853#
854# 1. Define the list algorithms and key types to accelerate,
855# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
856# Examples:
857# - loc_accel_list="ALG_JPAKE"
858# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200859# 2. Make configurations changes for the driver and/or main libraries.
860# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
861# can be either "default" to start with the default config, or a name
862# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200863# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200864# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
865# These changes affect both the driver and the main libraries.
866# (Note: they need to have the same set of PSA_WANT symbols, as that
867# determines the ABI between them.)
868# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
869# main libraries. Typically, you want to disable the module(s) that are
870# being accelerated. You may need to also disable modules that depend
871# on them or options that are not supported with drivers.
872# 2d. On top of psa/crypto_config.h, the driver library uses its own config
873# file: tests/include/test/drivers/config_test_driver.h. You usually
874# don't need to edit it: using loc_extra_list (see below) is preferred.
875# However, when there's no PSA symbol for what you want to enable,
876# calling scripts/config.py on this file remains the only option.
877# 3. Build the driver library, then the main libraries, test, and programs.
878# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
879# need to enable more algorithms here, typically hash algorithms when
880# accelerating some signature algorithms (ECDSA, RSAv2). This is done
881# by passing a 2nd argument listing the extra algorithms.
882# Example:
883# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
884# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800885# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200886# additional arguments will be passed to make: this can be useful if
887# you don't want to build everything when iterating during development.
888# Example:
889# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
890# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200891
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200892# Adjust the configuration - for both libtestdriver1 and main library,
893# as they should have the same PSA_WANT macros.
894helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200895 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200896 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200897 if [ "$base_config" != "default" ]; then
898 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 fi
900
901 # Enable PSA-based config (necessary to use drivers)
902 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
903
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200904 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
905 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
906 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000907
908 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
909 # otherwise we will end up running multithreaded tests without mutexes to protect them.
910 if scripts/config.py get MBEDTLS_THREADING_C; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
912 fi
913
914 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
915 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
916 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200917}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100918
Valerio Settib2fd6732023-08-15 17:10:47 +0200919# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200920# The function optionally accepts 1 parameter: a space-separated list of the
921# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200922helper_disable_builtin_curves() {
923 allowed_list="${1:-}"
924 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
925
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200926 for curve in $allowed_list; do
927 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200928 done
929}
930
931# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
932# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
933# in the following helpers.
934helper_get_psa_curve_list () {
935 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200936 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
937 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200938 done
939
940 echo "$loc_list"
941}
942
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100943# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
944# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
945# in the following helpers.
946helper_get_psa_dh_group_list () {
947 loc_list=""
948 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
949 loc_list="$loc_list $item"
950 done
951
952 echo "$loc_list"
953}
954
Valerio Settib2fd6732023-08-15 17:10:47 +0200955# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200956# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200957# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200958helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200959 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200960 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200961 for item in $(sed -n "s/^#define PSA_WANT_\(KEY_TYPE_${key_type}_[0-9A-Z_a-z]*\).*/\1/p" <"$CRYPTO_CONFIG_H"); do
Valerio Settib2fd6732023-08-15 17:10:47 +0200962 # Skip DERIVE for elliptic keys since there is no driver dispatch for
963 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200964 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
965 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200966 fi
967 done
968
969 echo "$loc_list"
970}
971
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200972# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200973#
974# Parameters:
975# 1. a space-separated list of things to accelerate;
976# 2. optional: a space-separate list of things to also support.
977# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
978helper_libtestdriver1_make_drivers() {
979 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100980 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200981}
982
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200983# Build the main libraries, programs and tests,
984# linking to the drivers library (with ASan).
985#
986# Parameters:
987# 1. a space-separated list of things to accelerate;
988# *. remaining arguments if any are passed directly to make
989# (examples: lib, -C tests test_suite_xxx, etc.)
990# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
991helper_libtestdriver1_make_main() {
992 loc_accel_list=$1
993 shift
994
995 # we need flags both with and without the LIBTESTDRIVER1_ prefix
996 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
997 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100998 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200999}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001000
1001################################################################
1002#### Basic checks
1003################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001004
1005#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001006# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001007#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001008# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001009# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001010# and/or are more likely to fail than others (eg I use Clang most of the
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001011# time, so start with a GCC build).
1012# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001013#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001014# Indicative running times are given for reference.
1015
Gilles Peskine8f073122018-11-27 15:58:47 +01001016component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001017 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001018 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001019}
Janos Follathb72c6782016-07-19 14:54:17 +01001020
Gilles Peskine67debb62021-05-18 16:09:50 +02001021component_check_generated_files () {
1022 msg "Check: check-generated-files, files generated with make" # 2s
1023 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001024 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001025
1026 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001027 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001028 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001029 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001030
1031 msg "Check: check-generated-files -u, files absent" # 2s
1032 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001033 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001034 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001035 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001036
1037 # This component ends with the generated files present in the source tree.
1038 # This is necessary for subsequent components!
1039}
1040
Gilles Peskine8f073122018-11-27 15:58:47 +01001041component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001042 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001043 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001044}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001045
Gilles Peskine8f073122018-11-27 15:58:47 +01001046component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001047 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001048 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001049}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001050
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001051component_check_changelog () {
1052 msg "Check: changelog entries" # < 1s
1053 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001054 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001055 if [ -e ChangeLog.new ]; then
1056 # Show the diff for information. It isn't an error if the diff is
1057 # non-empty.
1058 diff -u ChangeLog ChangeLog.new || true
1059 rm ChangeLog.new
1060 fi
1061}
1062
Gilles Peskine8f073122018-11-27 15:58:47 +01001063component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001064 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001065 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001066}
Darryl Greena07039c2018-03-13 16:48:16 +00001067
Gilles Peskine895868b2019-09-19 21:30:05 +02001068component_check_test_cases () {
1069 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001070 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001071 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001072 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001073 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001074 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001075 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001076 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001077}
1078
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001079component_check_test_dependencies () {
1080 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001081 # The purpose of this component is to catch unjustified dependencies on
1082 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1083 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1084 # MBEDTLS_PSA_xxx).
1085 #
1086 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1087 # this component is meant to catch. However a few of them are justified,
1088 # mostly by the absence of a PSA equivalent, so this component includes a
1089 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001090
1091 found="check-test-deps-found-$$"
1092 expected="check-test-deps-expected-$$"
1093
1094 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001095 grep 'depends_on' \
1096 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001097 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001098 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001099 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001100
Yanray Wang18040ed2023-11-23 21:29:56 +08001101 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001102 rm -f $expected
1103 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1104 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001105 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1106 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001107 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1108 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001109 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1110 # the test code and that's probably the most convenient way of achieving
1111 # the test's goal.
1112 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1113 # No PSA equivalent - we should probably have one in the future.
1114 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1115 # No PSA equivalent - needed by some init tests
1116 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001117 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001118 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001119
1120 # Compare reality with expectation.
1121 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001122 #
1123 # The output should be empty. When it's not:
1124 # - Each '+' line is a macro that was found but not expected. You want to
1125 # find where that macro occurs, and either replace it with PSA macros, or
1126 # add it to the exceptions list above with a justification.
1127 # - Each '-' line is a macro that was expected but not found; it means the
1128 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001129 diff -U0 $expected $found
1130
1131 rm $found $expected
1132}
1133
Gilles Peskine8f073122018-11-27 15:58:47 +01001134component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001135 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001136 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001137}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001138
Gilles Peskine192c72f2017-12-21 15:59:21 +01001139
Gilles Peskine636c26a2020-03-04 20:46:15 +01001140
Gilles Peskine192c72f2017-12-21 15:59:21 +01001141################################################################
1142#### Build and test many configurations and targets
1143################################################################
1144
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001145component_test_default_out_of_box () {
1146 msg "build: make, default config (out-of-box)" # ~1min
1147 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001148 # Disable fancy stuff
1149 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001150
1151 msg "test: main suites make, default config (out-of-box)" # ~10s
1152 make test
1153
1154 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001155 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001156
1157 msg "program demos: make, default config (out-of-box)" # ~10s
1158 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001159}
1160
Gilles Peskine8f073122018-11-27 15:58:47 +01001161component_test_default_cmake_gcc_asan () {
1162 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001163 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1164 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001165
Gilles Peskine8f073122018-11-27 15:58:47 +01001166 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1167 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001168
Gilles Peskine82b27272019-06-14 18:27:03 +02001169 msg "program demos (ASan build)" # ~10s
1170 tests/scripts/run_demos.py
1171
Gilles Peskine97bea012020-04-23 23:37:45 +02001172 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001173 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001174
Gilles Peskine6848d172023-11-02 19:58:03 +01001175 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001176 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001177
Gilles Peskine8f073122018-11-27 15:58:47 +01001178 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001179 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001180
Gilles Peskine8f073122018-11-27 15:58:47 +01001181 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001182 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001183
1184 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001185 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001186}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001187
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001188component_test_default_cmake_gcc_asan_new_bignum () {
1189 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001190 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001191 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001192 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001193
1194 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1195 make test
1196
1197 msg "test: selftest (ASan build)" # ~ 10s
1198 programs/test/selftest
1199
1200 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1201 tests/ssl-opt.sh
1202
1203 msg "test: compat.sh (ASan build)" # ~ 6 min
1204 tests/compat.sh
1205
1206 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1207 tests/context-info.sh
1208}
1209
Hanno Becker01635512019-02-26 14:27:09 +00001210component_test_full_cmake_gcc_asan () {
1211 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001212 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001213 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1214 make
1215
1216 msg "test: main suites (inc. selftests) (full config, ASan build)"
1217 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001218
Gilles Peskine97bea012020-04-23 23:37:45 +02001219 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001220 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001221
Gilles Peskine636c26a2020-03-04 20:46:15 +01001222 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001223 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001224
1225 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001226 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001227
1228 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001229 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001230}
1231
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001232
1233component_test_full_cmake_gcc_asan_new_bignum () {
1234 msg "build: full config, cmake, gcc, ASan"
1235 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001236 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001237 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001238 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001239
1240 msg "test: main suites (inc. selftests) (full config, ASan build)"
1241 make test
1242
1243 msg "test: selftest (ASan build)" # ~ 10s
1244 programs/test/selftest
1245
1246 msg "test: ssl-opt.sh (full config, ASan build)"
1247 tests/ssl-opt.sh
1248
1249 msg "test: compat.sh (full config, ASan build)"
1250 tests/compat.sh
1251
1252 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1253 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001254}
1255
Ronald Cronc3623db2020-10-29 10:51:32 +01001256component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001257 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001258 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001259 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1260 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1261 make
1262
1263 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1264 make test
1265}
1266
David Horstmann4a48bec2024-03-13 15:42:31 +00001267component_test_psa_assume_exclusive_buffers () {
1268 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001269 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001270 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001271 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1272 make
1273
David Horstmann4a48bec2024-03-13 15:42:31 +00001274 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001275 make test
1276}
1277
Gilles Peskinea3548672021-06-17 11:37:52 +02001278# check_renamed_symbols HEADER LIB
1279# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1280# name is LIB.
1281check_renamed_symbols () {
1282 ! nm "$2" | sed 's/.* //' |
1283 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1284}
1285
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001286component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001287 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001288 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001289 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1290 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1291 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1292 # We can only compile, not link, since our test and sample programs
1293 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1294 # is active.
1295 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001296
1297 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1298 # version is not present.
1299 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001300 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001301}
1302
Valerio Setti63097752024-03-12 13:18:13 +01001303# Get a list of library-wise undefined symbols and ensure that they only
1304# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1305# This function is a common helper used by both:
1306# - component_test_default_psa_crypto_client_without_crypto_provider
1307# - component_build_full_psa_crypto_client_without_crypto_provider.
1308common_check_mbedtls_missing_symbols() {
1309 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1310 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1311 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1312 not grep mbedtls_ linking_errors.txt
1313
1314 rm sym_def.txt sym_undef.txt linking_errors.txt
1315}
1316
1317component_test_default_psa_crypto_client_without_crypto_provider () {
1318 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1319
Ronald Cron336678b2021-01-28 17:54:24 +01001320 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1321 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001322 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001323 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001324 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001325 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001326
Ronald Cron336678b2021-01-28 17:54:24 +01001327 make
1328
Valerio Setti63097752024-03-12 13:18:13 +01001329 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1330 common_check_mbedtls_missing_symbols
1331
1332 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001333 make test
1334}
1335
Valerio Setti63097752024-03-12 13:18:13 +01001336component_build_full_psa_crypto_client_without_crypto_provider () {
1337 msg "build: full config - PSA_CRYPTO_C"
1338
1339 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1340 scripts/config.py full
1341
1342 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1343 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1344 # Dynamic secure element support is a deprecated feature and it is not
1345 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1346 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1347
1348 # Since there is no crypto provider in this build it is not possible to
1349 # build all the test executables and progrems due to missing PSA functions
1350 # at link time. Therefore we will just build libraries and we'll check
1351 # that symbols of interest are there.
1352 make lib
1353
1354 msg "check missing symbols: full config - PSA_CRYPTO_C"
1355
1356 common_check_mbedtls_missing_symbols
1357
1358 # Ensure that desired functions are included into the build (extend the
1359 # following list as required).
1360 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1361 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1362 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1363}
1364
Jaeden Amero424fa932021-05-14 08:34:32 +01001365component_test_psa_crypto_rsa_no_genprime() {
1366 msg "build: default config minus MBEDTLS_GENPRIME"
1367 scripts/config.py unset MBEDTLS_GENPRIME
1368 make
1369
1370 msg "test: default config minus MBEDTLS_GENPRIME"
1371 make test
1372}
1373
Gilles Peskine782f4112018-11-27 16:11:09 +01001374component_test_ref_configs () {
1375 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001376 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1377 # want to re-generate generated files that depend on it, quite correctly.
1378 # However this doesn't work as the generation script expects a specific
1379 # format for mbedtls_config.h, which the other files don't follow. Also,
1380 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001381 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001382 # whether they're on or off. So, disable cmake's (over-sensitive here)
1383 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001384 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001385 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001386 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001387}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001388
Gilles Peskine8f073122018-11-27 15:58:47 +01001389component_test_no_renegotiation () {
1390 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001391 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001392 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001393 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001394
Gilles Peskine8f073122018-11-27 15:58:47 +01001395 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1396 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001397
Gilles Peskine8f073122018-11-27 15:58:47 +01001398 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001399 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001400}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001401
Gilles Peskine636c26a2020-03-04 20:46:15 +01001402component_test_no_pem_no_fs () {
1403 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1404 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1405 scripts/config.py unset MBEDTLS_FS_IO
1406 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1407 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001408 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001409 make
1410
1411 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1412 make test
1413
1414 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001415 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001416}
1417
Gilles Peskine8f073122018-11-27 15:58:47 +01001418component_test_rsa_no_crt () {
1419 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001420 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001421 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001422 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001423
Gilles Peskine8f073122018-11-27 15:58:47 +01001424 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1425 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001426
Gilles Peskine8f073122018-11-27 15:58:47 +01001427 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001428 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001429
Gilles Peskine8f073122018-11-27 15:58:47 +01001430 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001431 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001432
1433 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001434 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001435}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001436
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001437component_test_no_ctr_drbg_classic () {
1438 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001439 scripts/config.py full
1440 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001441 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001442 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001443
Dave Rodgman17127e92023-12-14 16:42:48 +00001444 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001445 make
1446
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001447 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001448 make test
1449
Gilles Peskineba749042021-01-13 20:02:03 +01001450 # In this configuration, the TLS test programs use HMAC_DRBG.
1451 # The SSL tests are slow, so run a small subset, just enough to get
1452 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001453 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001454 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001455
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001456 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001457 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001458}
1459
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001460component_test_no_ctr_drbg_use_psa () {
1461 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001462 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001463 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1464 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001465
Dave Rodgman17127e92023-12-14 16:42:48 +00001466 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001467 make
1468
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001469 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1470 make test
1471
1472 # In this configuration, the TLS test programs use HMAC_DRBG.
1473 # The SSL tests are slow, so run a small subset, just enough to get
1474 # confidence that the SSL code copes with HMAC_DRBG.
1475 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001476 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001477
1478 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001479 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001480}
1481
1482component_test_no_hmac_drbg_classic () {
1483 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1484 scripts/config.py full
1485 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1486 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1487 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001488 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001489
Dave Rodgman17127e92023-12-14 16:42:48 +00001490 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001491 make
1492
1493 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001494 make test
1495
Gilles Peskinea2224342020-11-19 22:14:34 +01001496 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1497 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1498 # instead.
1499 # Test SSL with non-deterministic ECDSA. Only test features that
1500 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001501 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001502 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001503
1504 # To save time, only test one protocol version, since this part of
1505 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001506 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001507 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001508}
1509
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001510component_test_no_hmac_drbg_use_psa () {
1511 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1512 scripts/config.py full
1513 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1514 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1515 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1516
Dave Rodgman17127e92023-12-14 16:42:48 +00001517 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001518 make
1519
1520 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1521 make test
1522
1523 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1524 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1525 # instead.
1526 # Test SSL with non-deterministic ECDSA. Only test features that
1527 # might be affected by how ECDSA signature is performed.
1528 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001529 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001530
1531 # To save time, only test one protocol version, since this part of
1532 # the protocol is identical in (D)TLS up to 1.2.
1533 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001534 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001535}
1536
1537component_test_psa_external_rng_no_drbg_classic () {
1538 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1539 scripts/config.py full
1540 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001541 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001542 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001543 scripts/config.py unset MBEDTLS_ENTROPY_C
1544 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1545 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001546 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1547 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1548 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001549 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1550 # the SSL test programs don't have an RNG and can't work. Explicitly
1551 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001552 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001553
1554 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1555 make test
1556
Gilles Peskine8eb29432021-02-03 20:07:11 +01001557 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001558 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001559}
1560
1561component_test_psa_external_rng_no_drbg_use_psa () {
1562 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001563 scripts/config.py full
1564 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001565 scripts/config.py unset MBEDTLS_ENTROPY_C
1566 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1567 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001568 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1569 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1570 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001571 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001572
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001573 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001574 make test
1575
Gilles Peskine8eb29432021-02-03 20:07:11 +01001576 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001577 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001578}
1579
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001580component_test_psa_external_rng_use_psa_crypto () {
1581 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1582 scripts/config.py full
1583 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1584 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1585 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001586 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001587
1588 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1589 make test
1590
1591 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1592 tests/ssl-opt.sh -f 'Default\|opaque'
1593}
1594
Gilles Peskine801c4332023-04-28 21:04:28 +02001595component_test_psa_inject_entropy () {
1596 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1597 scripts/config.py full
1598 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1599 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1600 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1601 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1602 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1603 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001604 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 +02001605
1606 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1607 make test
1608}
1609
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001610component_test_sw_inet_pton () {
1611 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1612
1613 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1614 scripts/config.py set MBEDTLS_TEST_HOOKS
1615 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1616
1617 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1618 make test
1619}
1620
Valerio Settia41654d2024-02-08 10:33:11 +01001621component_full_no_pkparse_pkwrite() {
1622 msg "build: full without pkparse and pkwrite"
1623
1624 scripts/config.py crypto_full
1625 scripts/config.py unset MBEDTLS_PK_PARSE_C
1626 scripts/config.py unset MBEDTLS_PK_WRITE_C
1627
Valerio Settia41654d2024-02-08 10:33:11 +01001628 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1629
1630 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1631 not grep mbedtls_pk_parse_key library/pkparse.o
1632 not grep mbedtls_pk_write_key_der library/pkwrite.o
1633
1634 msg "test: full without pkparse and pkwrite"
1635 make test
1636}
1637
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001638component_test_crypto_full_md_light_only () {
1639 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001640 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001641 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001642 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001643 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001644 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001645 scripts/config.py unset MBEDTLS_HKDF_C
1646 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001647 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001648 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001649 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001650 # Disable things that would auto-enable MD_C
1651 scripts/config.py unset MBEDTLS_PKCS5_C
1652
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001653 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1654 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001655 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001656
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001657 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001658 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001659 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001660
1661 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001662 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001663}
1664
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001665component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001666 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001667 scripts/config.py full
1668 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001669 # Don't pull in cipher via PSA mechanisms
1670 # (currently ignored anyway because we completely disable PSA)
1671 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001672 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001673 scripts/config.py unset MBEDTLS_CMAC_C
1674 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001675 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001676 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001677 scripts/config.py unset MBEDTLS_SSL_TLS_C
1678 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001679 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001680 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1681 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001682 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001683 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001684 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001685
Valerio Settidf17a102023-10-23 14:14:19 +02001686 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001687 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001688}
1689
Valerio Setti7e710e82023-08-25 09:14:15 +02001690# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001691# - component_test_full_no_cipher_with_psa_crypto
1692# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001693# It accepts 2 input parameters:
1694# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1695# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001696common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001697 USE_CRYPTO_CONFIG="$1"
1698 COMPONENT_DESCRIPTION="$2"
1699
1700 msg "build: $COMPONENT_DESCRIPTION"
1701
1702 scripts/config.py full
1703 scripts/config.py unset MBEDTLS_CIPHER_C
1704
1705 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001706 # The built-in implementation of the following algs/key-types depends
1707 # on CIPHER_C so we disable them.
1708 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1709 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001710 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001711 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1712 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1713 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1714 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1715 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1716 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1717 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1718 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001719 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001720 else
1721 # Don't pull in cipher via PSA mechanisms
1722 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001723 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1724 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1725 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001726 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001727 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001728 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001729 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001730
Gilles Peskine21570cf2023-12-22 11:49:50 +01001731 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001732
Valerio Setti7e710e82023-08-25 09:14:15 +02001733 # Ensure that CIPHER_C was not re-enabled
1734 not grep mbedtls_cipher_init library/cipher.o
1735
1736 msg "test: $COMPONENT_DESCRIPTION"
1737 make test
1738}
1739
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001740component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001741 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001742}
1743
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001744component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001745 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001746}
1747
Valerio Settibdfecb62023-11-07 15:37:20 +01001748component_test_full_no_ccm() {
1749 msg "build: full no PSA_WANT_ALG_CCM"
1750
1751 # Full config enables:
1752 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1753 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1754 scripts/config.py full
1755
1756 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1757 # enabled, but not used from TLS since USE_PSA is set.
1758 # This is helpful to ensure that TLS tests below have proper dependencies.
1759 #
1760 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1761 # PSA_WANT_ALG_CCM to be re-enabled.
1762 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1763
Gilles Peskine21570cf2023-12-22 11:49:50 +01001764 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001765
1766 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001767 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001768}
1769
1770component_test_full_no_ccm_star_no_tag() {
1771 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1772
1773 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1774 scripts/config.py full
1775
1776 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1777 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1778 # This basically disables all unauthenticated ciphers on the PSA side, while
1779 # keeping AEADs enabled.
1780 #
1781 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1782 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1783 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1784 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1785 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1786 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1787 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1788 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1789 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1790 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1791
Gilles Peskine21570cf2023-12-22 11:49:50 +01001792 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001793
1794 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001795 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001796
1797 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001798 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001799}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001800
Valerio Settie1655b82023-01-03 15:35:25 +01001801component_test_full_no_bignum () {
1802 msg "build: full minus bignum"
1803 scripts/config.py full
1804 scripts/config.py unset MBEDTLS_BIGNUM_C
1805 # Direct dependencies of bignum
1806 scripts/config.py unset MBEDTLS_ECP_C
1807 scripts/config.py unset MBEDTLS_RSA_C
1808 scripts/config.py unset MBEDTLS_DHM_C
1809 # Direct dependencies of ECP
1810 scripts/config.py unset MBEDTLS_ECDH_C
1811 scripts/config.py unset MBEDTLS_ECDSA_C
1812 scripts/config.py unset MBEDTLS_ECJPAKE_C
1813 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001814 # Disable what auto-enables ECP_LIGHT
1815 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1816 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001817 # Indirect dependencies of ECP
1818 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1819 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1820 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1821 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1822 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1823 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1824 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1825 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1826 # Direct dependencies of DHM
1827 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1828 # Direct dependencies of RSA
1829 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1830 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1831 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1832 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1833 # PK and its dependencies
1834 scripts/config.py unset MBEDTLS_PK_C
1835 scripts/config.py unset MBEDTLS_PK_PARSE_C
1836 scripts/config.py unset MBEDTLS_PK_WRITE_C
1837 scripts/config.py unset MBEDTLS_X509_USE_C
1838 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1839 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1840 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1841 scripts/config.py unset MBEDTLS_X509_CREATE_C
1842 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1843 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1844 scripts/config.py unset MBEDTLS_PKCS7_C
1845 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1846 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1847 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1848
Gilles Peskine21570cf2023-12-22 11:49:50 +01001849 make
Valerio Settie1655b82023-01-03 15:35:25 +01001850
1851 msg "test: full minus bignum"
1852 make test
1853}
1854
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001855component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001856 msg "build: default with only stream cipher"
1857
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001858 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001859 scripts/config.py unset MBEDTLS_GCM_C
1860 scripts/config.py unset MBEDTLS_CCM_C
1861 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001862 #Disable TLS 1.3 (as no AEAD)
1863 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001864 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001865 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001866 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001867 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001868 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1869 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001870 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001871 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001872 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001873
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001874 make
1875
1876 msg "test: default with only stream cipher"
1877 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001878
1879 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001880}
1881
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001882component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001883 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001884
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001885 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001886 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001887 scripts/config.py unset MBEDTLS_GCM_C
1888 scripts/config.py unset MBEDTLS_CCM_C
1889 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001890 #Disable TLS 1.3 (as no AEAD)
1891 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001892 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel9550c052022-09-28 09:51:55 +02001893 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001894 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001895 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001896 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1897 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001898 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001899 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001900 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001901
Przemek Stekiel9550c052022-09-28 09:51:55 +02001902 make
1903
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001904 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001905 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001906
1907 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001908}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001909
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001910component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001911 msg "build: default with only CBC-legacy cipher"
1912
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001913 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001914 scripts/config.py unset MBEDTLS_GCM_C
1915 scripts/config.py unset MBEDTLS_CCM_C
1916 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001917 #Disable TLS 1.3 (as no AEAD)
1918 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001919 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1920 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1921 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001922 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001923 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001924 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001925 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001926 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001927 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001928
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001929 make
1930
1931 msg "test: default with only CBC-legacy cipher"
1932 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001933
1934 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1935 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001936}
1937
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001938component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001939 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001940
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001941 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001942 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001943 scripts/config.py unset MBEDTLS_GCM_C
1944 scripts/config.py unset MBEDTLS_CCM_C
1945 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001946 #Disable TLS 1.3 (as no AEAD)
1947 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001948 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1949 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1950 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001951 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001952 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001953 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001954 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001955 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001956 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001957
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001958 make
1959
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001960 msg "test: default with only CBC-legacy cipher use psa"
1961 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001962
1963 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1964 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001965}
1966
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001967component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001968 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1969
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001970 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001971 scripts/config.py unset MBEDTLS_GCM_C
1972 scripts/config.py unset MBEDTLS_CCM_C
1973 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001974 #Disable TLS 1.3 (as no AEAD)
1975 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001976 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1977 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1978 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1979 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1980 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001981 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001982 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001983 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001984 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001985
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001986 make
1987
1988 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1989 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001990
1991 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1992 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001993}
1994
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001995component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1996 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001997
1998 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001999 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002000 scripts/config.py unset MBEDTLS_GCM_C
2001 scripts/config.py unset MBEDTLS_CCM_C
2002 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002003 #Disable TLS 1.3 (as no AEAD)
2004 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002005 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2006 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2007 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2008 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2009 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002010 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002011 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002012 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002013 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002014
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002015 make
2016
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002017 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002018 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002019
2020 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2021 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002022}
2023
Valerio Setti9f0ec532022-11-08 13:03:24 +01002024# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2025# that we could use for interop testing. However, we now have sort of two
2026# implementations ourselves: one using PSA, the other not. At least test that
2027# these two interoperate with each other.
2028component_test_tls1_2_ecjpake_compatibility() {
2029 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2030 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002031 # Explicitly make lib first to avoid a race condition:
2032 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2033 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002034 make -C programs ssl/ssl_server2 ssl/ssl_client2
2035 cp programs/ssl/ssl_server2 s2_no_use_psa
2036 cp programs/ssl/ssl_client2 c2_no_use_psa
2037
2038 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2039 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2040 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002041 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002042 make -C programs ssl/ssl_server2 ssl/ssl_client2
2043 make -C programs test/udp_proxy test/query_compile_time_config
2044
Valerio Setti70e02902022-12-02 16:21:56 +01002045 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2046 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2047 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2048 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2049 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2050 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2051 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2052 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 +01002053
2054 rm s2_no_use_psa c2_no_use_psa
2055}
2056
Gilles Peskine636c26a2020-03-04 20:46:15 +01002057component_test_everest () {
2058 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2059 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2060 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2061 make
2062
2063 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2064 make test
2065
Gilles Peskine6848d172023-11-02 19:58:03 +01002066 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002067 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002068
Gilles Peskine636c26a2020-03-04 20:46:15 +01002069 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2070 tests/ssl-opt.sh -f ECDH
2071
2072 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2073 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002074 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002075}
2076
Gilles Peskined3beca92020-07-03 00:15:37 +02002077component_test_everest_curve25519_only () {
2078 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002079 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2080 scripts/config.py unset MBEDTLS_ECDSA_C
2081 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2082 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002083 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002084 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002085 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002086 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2087
Dave Rodgman17127e92023-12-14 16:42:48 +00002088 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002089
2090 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2091 make test
2092}
2093
Gilles Peskine8f073122018-11-27 15:58:47 +01002094component_test_small_ssl_out_content_len () {
2095 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002096 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2097 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002098 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002099 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002100
Gilles Peskine8f073122018-11-27 15:58:47 +01002101 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002102 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002103}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002104
Gilles Peskine8f073122018-11-27 15:58:47 +01002105component_test_small_ssl_in_content_len () {
2106 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002107 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2108 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002109 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002110 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002111
Gilles Peskine8f073122018-11-27 15:58:47 +01002112 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002113 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002114}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002115
Gilles Peskine8f073122018-11-27 15:58:47 +01002116component_test_small_ssl_dtls_max_buffering () {
2117 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002118 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002119 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002120 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002121
Gilles Peskine8f073122018-11-27 15:58:47 +01002122 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002123 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 +01002124}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002125
Gilles Peskine8f073122018-11-27 15:58:47 +01002126component_test_small_mbedtls_ssl_dtls_max_buffering () {
2127 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002128 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002129 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002130 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002131
Gilles Peskine8f073122018-11-27 15:58:47 +01002132 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002133 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002134}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002135
Gilles Peskine75cc7712019-09-06 19:47:17 +02002136component_test_psa_collect_statuses () {
2137 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002138 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002139 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002140 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002141 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002142 rm -f tests/statuses.log
2143}
2144
Gilles Peskine8f073122018-11-27 15:58:47 +01002145component_test_full_cmake_clang () {
2146 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002147 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002148 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 +01002149 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002150
k-stachowiak0291cb72019-06-26 15:52:12 +02002151 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002152 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002153
Gilles Peskineda6017c2022-10-30 21:02:40 +01002154 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2155 programs/test/cpp_dummy_build
2156
Gilles Peskine6848d172023-11-02 19:58:03 +01002157 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002158 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002159
Gilles Peskine82b27272019-06-14 18:27:03 +02002160 msg "program demos (full config, clang)" # ~10s
2161 tests/scripts/run_demos.py
2162
k-stachowiak0291cb72019-06-26 15:52:12 +02002163 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002164 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002165
Gilles Peskine8f073122018-11-27 15:58:47 +01002166 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002167 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002168
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002169 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002170 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002171
Gilles Peskine8f073122018-11-27 15:58:47 +01002172 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002173 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002174}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002175
Gilles Peskine0c671602022-11-29 16:01:41 +01002176skip_suites_without_constant_flow () {
2177 # Skip the test suites that don't have any constant-flow annotations.
2178 # This will need to be adjusted if we ever start declaring things as
2179 # secret from macros or functions inside tests/include or tests/src.
2180 SKIP_TEST_SUITES=$(
2181 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2182 sed 's/test_suite_//; s/\.function$//' |
2183 tr '\n' ,)
2184 export SKIP_TEST_SUITES
2185}
2186
Dave Rodgman246210e2023-07-31 18:07:44 +01002187skip_all_except_given_suite () {
2188 # Skip all but the given test suite
2189 SKIP_TEST_SUITES=$(
2190 ls -1 tests/suites/test_suite_*.function |
2191 grep -v $1.function |
2192 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2193 tr '\n' ,)
2194 export SKIP_TEST_SUITES
2195}
2196
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002197component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002198 # This tests both (1) accesses to undefined memory, and (2) branches or
2199 # memory access depending on secret values. To distinguish between those:
2200 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2201 # - or alternatively, change the build type to MemSanDbg, which enables
2202 # origin tracking and nicer stack traces (which are useful for debugging
2203 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002204 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2205 scripts/config.py full
2206 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2207 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2208 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2209 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2210 make
2211
2212 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2213 make test
2214}
2215
2216component_test_memsan_constant_flow_psa () {
2217 # This tests both (1) accesses to undefined memory, and (2) branches or
2218 # memory access depending on secret values. To distinguish between those:
2219 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2220 # - or alternatively, change the build type to MemSanDbg, which enables
2221 # origin tracking and nicer stack traces (which are useful for debugging
2222 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002223 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002224 scripts/config.py full
2225 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2226 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2227 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2228 make
2229
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002230 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002231 make test
2232}
2233
Bence Szépkúti0354d042023-12-06 16:14:37 +01002234component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002235 # This tests both (1) everything that valgrind's memcheck usually checks
2236 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2237 # etc.) and (2) branches or memory access depending on secret values,
2238 # which will be reported as uninitialized memory. To distinguish between
2239 # secret and actually uninitialized:
2240 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2241 # - or alternatively, build with debug info and manually run the offending
2242 # test suite with valgrind --track-origins=yes, then check if the origin
2243 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002244 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2245 scripts/config.py full
2246 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2247 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002248 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002249 cmake -D CMAKE_BUILD_TYPE:String=Release .
2250 make
2251
2252 # this only shows a summary of the results (how many of each type)
2253 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002254 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002255 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002256
2257 # Test asm path in constant time module - by default, it will test the plain C
2258 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2259 msg "test: valgrind asm constant_time"
2260 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2261 skip_all_except_given_suite test_suite_constant_time
2262 cmake -D CMAKE_BUILD_TYPE:String=Release .
2263 make clean
2264 make
2265 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002266}
2267
Bence Szépkúti0354d042023-12-06 16:14:37 +01002268component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002269 # This tests both (1) everything that valgrind's memcheck usually checks
2270 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2271 # etc.) and (2) branches or memory access depending on secret values,
2272 # which will be reported as uninitialized memory. To distinguish between
2273 # secret and actually uninitialized:
2274 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2275 # - or alternatively, build with debug info and manually run the offending
2276 # test suite with valgrind --track-origins=yes, then check if the origin
2277 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002278 msg "build: cmake release GCC, full config with constant flow testing"
2279 scripts/config.py full
2280 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002281 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002282 cmake -D CMAKE_BUILD_TYPE:String=Release .
2283 make
2284
2285 # this only shows a summary of the results (how many of each type)
2286 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002287 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002288 make memcheck
2289}
2290
Janos Follath9338cac2023-10-04 18:55:39 +01002291component_test_tsan () {
2292 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002293 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002294 scripts/config.py set MBEDTLS_THREADING_C
2295 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002296 # Self-tests do not currently use multiple threads.
2297 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002298
Ryan6caf84f2024-03-05 13:57:00 +00002299 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2300 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2301
Janos Follath9338cac2023-10-04 18:55:39 +01002302 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2303 make
2304
2305 msg "test: main suites (TSan)"
2306 make test
2307}
2308
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002309component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002310 # Test that removing the deprecated features from the default
2311 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002312 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2313 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002314 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002315
2316 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2317 make test
2318}
2319
2320component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002321 msg "build: make, full_no_deprecated config" # ~ 30s
2322 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002323 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002324
Gilles Peskine30de2e82020-04-20 21:39:22 +02002325 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002326 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002327
2328 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2329 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002330}
2331
Gilles Peskine8386ea22020-04-30 09:07:29 +02002332component_test_full_no_deprecated_deprecated_warning () {
2333 # Test that there is nothing deprecated in "full_no_deprecated".
2334 # A deprecated feature would trigger a warning (made fatal) from
2335 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002336 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2337 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002338 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2339 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002340 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002341
Gilles Peskine30de2e82020-04-20 21:39:22 +02002342 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002343 make test
2344}
2345
Gilles Peskine8386ea22020-04-30 09:07:29 +02002346component_test_full_deprecated_warning () {
2347 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2348 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002349 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002350 scripts/config.py full
2351 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002352 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002353 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2354 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002355 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002356
Gilles Peskine8386ea22020-04-30 09:07:29 +02002357 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2358 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2359 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002360 # Expect warnings from '#warning' directives in check_config.h and
2361 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002362 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 +01002363
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002364 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2365 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002366
2367 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2368 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002369}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002370
Gilles Peskineec541fe2020-01-31 14:24:14 +01002371# Check that the specified libraries exist and are empty.
2372are_empty_libraries () {
2373 nm "$@" >/dev/null 2>/dev/null
2374 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2375}
2376
2377component_build_crypto_default () {
2378 msg "build: make, crypto only"
2379 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002380 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002381 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002382}
2383
2384component_build_crypto_full () {
2385 msg "build: make, crypto only, full config"
2386 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002387 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002388 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002389}
2390
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002391component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002392 msg "build: make, config for PSA crypto service"
2393 scripts/config.py crypto
2394 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2395 # Disable things that are not needed for just cryptography, to
2396 # reach a configuration that would be typical for a PSA cryptography
2397 # service providing all implemented PSA algorithms.
2398 # System stuff
2399 scripts/config.py unset MBEDTLS_ERROR_C
2400 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002401 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002402 # Crypto stuff with no PSA interface
2403 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002404 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002405 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002406 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002407 scripts/config.py unset MBEDTLS_NIST_KW_C
2408 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2409 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2410 scripts/config.py unset MBEDTLS_PKCS12_C
2411 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002412 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2413 # in PSA code to work with RSA keys. We don't require users to set those:
2414 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002415 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002416 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002417 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002418 make CFLAGS='-O1 -Werror' all test
2419 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2420}
2421
Gilles Peskineec541fe2020-01-31 14:24:14 +01002422component_build_crypto_baremetal () {
2423 msg "build: make, crypto only, baremetal config"
2424 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002425 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002426 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002427}
Daniel Axtens446af202020-09-02 21:30:13 +10002428support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002429 support_build_baremetal "$@"
2430}
2431
2432component_build_baremetal () {
2433 msg "build: make, baremetal config"
2434 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002435 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002436}
2437support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002438 # Older Glibc versions include time.h from other headers such as stdlib.h,
2439 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2440 # problem, Ubuntu 18.04 is ok.
2441 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2442}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002443
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002444# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002445component_test_depends_py_cipher_id () {
2446 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002447 tests/scripts/depends.py cipher_id --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_cipher_chaining () {
2451 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002452 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002453}
2454
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002455component_test_depends_py_cipher_padding () {
2456 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002457 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002458}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002459
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002460component_test_depends_py_curves () {
2461 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002462 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002463}
2464
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002465component_test_depends_py_hashes () {
2466 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002467 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002468}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002469
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002470component_test_depends_py_kex () {
2471 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002472 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002473}
2474
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002475component_test_depends_py_pkalgs () {
2476 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002477 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002478}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002479
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002480# PSA equivalents of the depends.py tests
2481component_test_depends_py_cipher_id_psa () {
2482 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002483 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002484}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002485
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002486component_test_depends_py_cipher_chaining_psa () {
2487 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002488 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002489}
2490
2491component_test_depends_py_cipher_padding_psa () {
2492 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002493 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002494}
2495
2496component_test_depends_py_curves_psa () {
2497 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002498 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002499}
2500
2501component_test_depends_py_hashes_psa () {
2502 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002503 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002504}
2505
2506component_test_depends_py_kex_psa () {
2507 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002508 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002509}
2510
2511component_test_depends_py_pkalgs_psa () {
2512 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002513 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002514}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002515
Valerio Setti6bed64e2024-01-17 15:21:44 +01002516component_test_psa_crypto_config_ffdh_2048_only () {
2517 msg "build: full config - only DH 2048"
2518
2519 scripts/config.py full
2520
2521 # Disable all DH groups other than 2048.
2522 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2523 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2524 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2525 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2526
2527 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2528
2529 msg "test: full config - only DH 2048"
2530 make test
2531
2532 msg "ssl-opt: full config - only DH 2048"
2533 tests/ssl-opt.sh -f "ffdh"
2534}
2535
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002536component_build_no_pk_rsa_alt_support () {
2537 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2538
2539 scripts/config.py full
2540 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2541 scripts/config.py set MBEDTLS_RSA_C
2542 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2543
2544 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002545 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002546}
2547
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002548component_build_module_alt () {
2549 msg "build: MBEDTLS_XXX_ALT" # ~30s
2550 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002551
2552 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002553 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2554 scripts/config.py unset MBEDTLS_AESNI_C
2555 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002556 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002557 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2558 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002559 # You can only have one threading implementation: alt or pthread, not both.
2560 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002561 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2562 # directly and assumes the implementation works with partial groups.
2563 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002564 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2565 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2566 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002567 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2568 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2569 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002570
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002571 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2572 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2573 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002574 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002575
Gilles Peskine1628a9c2021-05-31 22:09:58 +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 Peskine1628a9c2021-05-31 22:09:58 +02002579}
2580
2581component_build_dhm_alt () {
2582 msg "build: MBEDTLS_DHM_ALT" # ~30s
2583 scripts/config.py full
2584 scripts/config.py set MBEDTLS_DHM_ALT
2585 # debug.c currently references mbedtls_dhm_context fields directly.
2586 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002587 # We can only compile, not link, since we don't have any implementations
2588 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002589 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002590}
2591
Gilles Peskine64996c32024-01-23 20:25:47 +01002592component_test_no_psa_crypto_full_cmake_asan() {
2593 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2594 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002595 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002596 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002597 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002598 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002599 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002600 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002601 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002602 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002603 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002604 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002605 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002606 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002607
Gilles Peskine64996c32024-01-23 20:25:47 +01002608 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002609 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002610
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002611 # Note: ssl-opt.sh has some test cases that depend on
2612 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2613 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002614 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002615 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002616
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002617 msg "test: compat.sh default (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002618 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002619
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002620 msg "test: compat.sh NULL (full minus PSA crypto)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002621 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002622
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002623 msg "test: compat.sh ARIA + ChachaPoly (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002624 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002625}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002626
Ronald Cron403c15c2021-09-13 09:38:05 +02002627component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002628 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002629
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002630 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002631 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002632 $(helper_get_psa_key_type_list "ECC") \
2633 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002634
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002635 # Configure
2636 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002637
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002638 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002639 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002640
2641 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002642 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002643
2644 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002645 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2646 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2647
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002648 # Build
2649 # -----
2650
2651 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002652 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2653 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002654
2655 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2656
Valerio Setti3fe105b2023-10-30 11:08:12 +01002657 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002658
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002659 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002660 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002661
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002662 # Run the tests
2663 # -------------
2664
Ronald Cron403c15c2021-09-13 09:38:05 +02002665 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2666 make test
2667}
2668
Valerio Setti44b178c2023-03-22 14:02:57 +01002669component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002670 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002671
2672 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002673 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002674 $(helper_get_psa_key_type_list "ECC") \
2675 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002676
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002677 # Configure
2678 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002679
Ronald Cron46ac0652024-03-18 12:39:04 +01002680 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002681 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002682
Valerio Setti44b178c2023-03-22 14:02:57 +01002683 # Disable the module that's accelerated
2684 scripts/config.py unset MBEDTLS_ECDH_C
2685
2686 # Disable things that depend on it
2687 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2688 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2689 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2690 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2691 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2692
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002693 # Build
2694 # -----
2695
2696 helper_libtestdriver1_make_drivers "$loc_accel_list"
2697
Valerio Setti3fe105b2023-10-30 11:08:12 +01002698 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002699
Valerio Setti44b178c2023-03-22 14:02:57 +01002700 # Make sure this was not re-enabled by accident (additive config)
2701 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002702
2703 # Run the tests
2704 # -------------
2705
Valerio Setti44b178c2023-03-22 14:02:57 +01002706 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002707 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002708}
2709
Przemek Stekieldccb2022023-05-11 10:48:50 +02002710component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002711 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002712
2713 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002714 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002715 $(helper_get_psa_key_type_list "DH") \
2716 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002717
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002718 # Configure
2719 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002720
Przemek Stekiel565353e2023-07-05 11:07:07 +02002721 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002722 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002723
2724 # Disable the module that's accelerated
2725 scripts/config.py unset MBEDTLS_DHM_C
2726
2727 # Disable things that depend on it
2728 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2729 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2730
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002731 # Build
2732 # -----
2733
2734 helper_libtestdriver1_make_drivers "$loc_accel_list"
2735
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002736 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002737
2738 # Make sure this was not re-enabled by accident (additive config)
2739 not grep mbedtls_dhm_ library/dhm.o
2740
2741 # Run the tests
2742 # -------------
2743
Gilles Peskine14302ed2023-07-19 19:30:04 +02002744 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002745 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002746
Gilles Peskine14302ed2023-07-19 19:30:04 +02002747 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002748 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002749}
2750
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002751component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002752 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002753
2754 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002755 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002756
2757 # Disable things that are not supported
2758 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2759 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002760 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002761
Gilles Peskine14302ed2023-07-19 19:30:04 +02002762 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002763 make test
2764
Gilles Peskine14302ed2023-07-19 19:30:04 +02002765 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002766 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002767}
2768
Valerio Setti44b178c2023-03-22 14:02:57 +01002769component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002770 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002771
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002772 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002773 $(helper_get_psa_key_type_list "ECC") \
2774 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002775
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002776 # Configure
2777 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002778
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002779 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002780
2781 # Make built-in fallback not available
2782 scripts/config.py unset MBEDTLS_ECJPAKE_C
2783 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2784
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002785 # Build
2786 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002787
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002788 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002789
Valerio Setti3fe105b2023-10-30 11:08:12 +01002790 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002791
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002792 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002793 not grep mbedtls_ecjpake_init library/ecjpake.o
2794
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002795 # Run the tests
2796 # -------------
2797
Gilles Peskine14302ed2023-07-19 19:30:04 +02002798 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002799 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002800}
2801
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002802component_test_psa_crypto_config_accel_ecc_some_key_types () {
2803 msg "build: full with accelerated EC algs and some key types"
2804
2805 # Algorithms and key types to accelerate
2806 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2807 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2808 ALG_ECDH \
2809 ALG_JPAKE \
2810 KEY_TYPE_ECC_PUBLIC_KEY \
2811 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2812 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002813 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2814 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002815
2816 # Configure
2817 # ---------
2818
2819 # start with config full for maximum coverage (also enables USE_PSA)
2820 helper_libtestdriver1_adjust_config "full"
2821
2822 # Disable modules that are accelerated - some will be re-enabled
2823 scripts/config.py unset MBEDTLS_ECDSA_C
2824 scripts/config.py unset MBEDTLS_ECDH_C
2825 scripts/config.py unset MBEDTLS_ECJPAKE_C
2826 scripts/config.py unset MBEDTLS_ECP_C
2827
2828 # Disable all curves - those that aren't accelerated should be re-enabled
2829 helper_disable_builtin_curves
2830
2831 # Restartable feature is not yet supported by PSA. Once it will in
2832 # the future, the following line could be removed (see issues
2833 # 6061, 6332 and following ones)
2834 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2835
2836 # this is not supported by the driver API yet
2837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2838
2839 # Build
2840 # -----
2841
2842 # These hashes are needed for some ECDSA signature tests.
2843 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2844 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2845 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2846
Valerio Setti3fe105b2023-10-30 11:08:12 +01002847 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002848
2849 # ECP should be re-enabled but not the others
2850 not grep mbedtls_ecdh_ library/ecdh.o
2851 not grep mbedtls_ecdsa library/ecdsa.o
2852 not grep mbedtls_ecjpake library/ecjpake.o
2853 grep mbedtls_ecp library/ecp.o
2854
2855 # Run the tests
2856 # -------------
2857
2858 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002859 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002860}
2861
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002862# Run tests with only (non-)Weierstrass accelerated
2863# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002864# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2865# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002866common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002867 weierstrass=$1
2868 if [ $weierstrass -eq 1 ]; then
2869 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002870 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002871 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002872 fi
2873
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002874 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002875
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002876 # Note: Curves are handled in a special way by the libtestdriver machinery,
2877 # so we only want to include them in the accel list when building the main
2878 # libraries, hence the use of a separate variable.
2879 # Note: the following loop is a modified version of
2880 # helper_get_psa_curve_list that only keeps Weierstrass families.
2881 loc_weierstrass_list=""
2882 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002883 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2884 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002885 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002886 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002887 ;;
2888 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002889 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002890 ;;
2891 esac
2892 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002893 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002894 loc_curve_list=$loc_weierstrass_list
2895 else
2896 loc_curve_list=$loc_non_weierstrass_list
2897 fi
2898
Valerio Setti3fe105b2023-10-30 11:08:12 +01002899 # Algorithms and key types to accelerate
2900 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2901 ALG_ECDH \
2902 ALG_JPAKE \
2903 $(helper_get_psa_key_type_list "ECC") \
2904 $loc_curve_list"
2905
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002906 # Configure
2907 # ---------
2908
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002909 # Start with config crypto_full and remove PK_C:
2910 # that's what's supported now, see docs/driver-only-builds.md.
2911 helper_libtestdriver1_adjust_config "crypto_full"
2912 scripts/config.py unset MBEDTLS_PK_C
2913 scripts/config.py unset MBEDTLS_PK_PARSE_C
2914 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002915
2916 # Disable modules that are accelerated - some will be re-enabled
2917 scripts/config.py unset MBEDTLS_ECDSA_C
2918 scripts/config.py unset MBEDTLS_ECDH_C
2919 scripts/config.py unset MBEDTLS_ECJPAKE_C
2920 scripts/config.py unset MBEDTLS_ECP_C
2921
2922 # Disable all curves - those that aren't accelerated should be re-enabled
2923 helper_disable_builtin_curves
2924
2925 # Restartable feature is not yet supported by PSA. Once it will in
2926 # the future, the following line could be removed (see issues
2927 # 6061, 6332 and following ones)
2928 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2929
2930 # this is not supported by the driver API yet
2931 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2932
2933 # Build
2934 # -----
2935
2936 # These hashes are needed for some ECDSA signature tests.
2937 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2938 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2939 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2940
Valerio Settiac7a8092023-10-31 12:23:44 +01002941 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002942
2943 # We expect ECDH to be re-enabled for the missing curves
2944 grep mbedtls_ecdh_ library/ecdh.o
2945 # We expect ECP to be re-enabled, however the parts specific to the
2946 # families of curves that are accelerated should be ommited.
2947 # - functions with mxz in the name are specific to Montgomery curves
2948 # - ecp_muladd is specific to Weierstrass curves
2949 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002950 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002951 not grep mbedtls_ecp_muladd library/ecp.o
2952 grep mxz library/ecp.o
2953 else
2954 grep mbedtls_ecp_muladd library/ecp.o
2955 not grep mxz library/ecp.o
2956 fi
2957 # We expect ECDSA and ECJPAKE to be re-enabled only when
2958 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002959 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002960 not grep mbedtls_ecdsa library/ecdsa.o
2961 not grep mbedtls_ecjpake library/ecjpake.o
2962 else
2963 grep mbedtls_ecdsa library/ecdsa.o
2964 grep mbedtls_ecjpake library/ecjpake.o
2965 fi
2966
2967 # Run the tests
2968 # -------------
2969
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002970 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2971 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002972}
2973
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002974component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002975 common_test_psa_crypto_config_accel_ecc_some_curves 1
2976}
2977
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002978component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002979 common_test_psa_crypto_config_accel_ecc_some_curves 0
2980}
2981
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002982# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2983# ECDH, ECDSA) with and without drivers.
2984# The input parameter is a boolean value which indicates:
2985# - 0 keep built-in EC algs,
2986# - 1 exclude built-in EC algs (driver only).
2987#
2988# This is used by the two following components to ensure they always use the
2989# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002990# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2991# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002992# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002993config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002994 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002995 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002996 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002997 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002998 # Disable modules that are accelerated
2999 scripts/config.py unset MBEDTLS_ECDSA_C
3000 scripts/config.py unset MBEDTLS_ECDH_C
3001 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003002 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003003 fi
3004
3005 # Restartable feature is not yet supported by PSA. Once it will in
3006 # the future, the following line could be removed (see issues
3007 # 6061, 6332 and following ones)
3008 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003009}
3010
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003011# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3012component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003013 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003014
3015 # Algorithms and key types to accelerate
3016 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3017 ALG_ECDH \
3018 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003019 $(helper_get_psa_key_type_list "ECC") \
3020 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003021
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003022 # Configure
3023 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003024
3025 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003026 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003027
Valerio Setti0a342c92023-09-01 09:12:31 +02003028 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003029 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3030 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003031
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003032 # Build
3033 # -----
3034
3035 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003036 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3037 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003038 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3039
Valerio Setti3fe105b2023-10-30 11:08:12 +01003040 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003041
3042 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3043 not grep mbedtls_ecdsa_ library/ecdsa.o
3044 not grep mbedtls_ecdh_ library/ecdh.o
3045 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003046 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003047
3048 # Run the tests
3049 # -------------
3050
Gilles Peskine14302ed2023-07-19 19:30:04 +02003051 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003052 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003053
Gilles Peskine14302ed2023-07-19 19:30:04 +02003054 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003055 tests/ssl-opt.sh
3056}
3057
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003058# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3059component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003060 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003061
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003062 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003063
Gilles Peskine21570cf2023-12-22 11:49:50 +01003064 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003065
Gilles Peskine14302ed2023-07-19 19:30:04 +02003066 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003067 make test
3068
Gilles Peskine14302ed2023-07-19 19:30:04 +02003069 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003070 tests/ssl-opt.sh
3071}
3072
Valerio Settie618cb02023-04-12 14:59:16 +02003073# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003074# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3075# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003076# to ensure that both tests use the same underlying configuration when testing
3077# driver's coverage with analyze_outcomes.py.
3078#
3079# This functions accepts 1 boolean parameter as follows:
3080# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3081# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3082# - 0: include built-in implementation of EC algorithms.
3083#
3084# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3085# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003086config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003087 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003088 # start with full config for maximum coverage (also enables USE_PSA)
3089 helper_libtestdriver1_adjust_config "full"
3090
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003091 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003092 # Disable modules that are accelerated
3093 scripts/config.py unset MBEDTLS_ECDSA_C
3094 scripts/config.py unset MBEDTLS_ECDH_C
3095 scripts/config.py unset MBEDTLS_ECJPAKE_C
3096 # Disable ECP module (entirely)
3097 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003098 fi
3099
Valerio Settiaecd32c2023-06-14 10:42:31 +02003100 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3101 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003102 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003103 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003104
Valerio Settie618cb02023-04-12 14:59:16 +02003105 # Restartable feature is not yet supported by PSA. Once it will in
3106 # the future, the following line could be removed (see issues
3107 # 6061, 6332 and following ones)
3108 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003109}
3110
3111# Build and test a configuration where driver accelerates all EC algs while
3112# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3113# side.
3114#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003115# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3116component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003117 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003118
3119 # Algorithms and key types to accelerate
3120 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3121 ALG_ECDH \
3122 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003123 $(helper_get_psa_key_type_list "ECC") \
3124 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003125
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003126 # Configure
3127 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003128
Valerio Settie618cb02023-04-12 14:59:16 +02003129 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003130 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003131 # Disable all the builtin curves. All the required algs are accelerated.
3132 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003133
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003134 # Build
3135 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003136
3137 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003138 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3139 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3140 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003141
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003142 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003143
Valerio Setti3fe105b2023-10-30 11:08:12 +01003144 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003145
3146 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3147 not grep mbedtls_ecdsa_ library/ecdsa.o
3148 not grep mbedtls_ecdh_ library/ecdh.o
3149 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003150 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003151 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003152
3153 # Run the tests
3154 # -------------
3155
Gilles Peskine14302ed2023-07-19 19:30:04 +02003156 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003157 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003158
Gilles Peskine14302ed2023-07-19 19:30:04 +02003159 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003160 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003161}
3162
3163# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003164# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003165# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003166component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003167 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003168
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003169 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003170
Gilles Peskine21570cf2023-12-22 11:49:50 +01003171 make
Valerio Settie618cb02023-04-12 14:59:16 +02003172
Gilles Peskine14302ed2023-07-19 19:30:04 +02003173 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003174 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003175
Gilles Peskine14302ed2023-07-19 19:30:04 +02003176 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003177 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003178}
3179
Valerio Setti4e2f2442023-08-15 10:10:26 +02003180# This is a common configuration helper used directly from:
3181# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3182# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3183# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003184# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003185# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003186# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003187# - this is the reference component of the above
3188# - it still disables RSA and FFDH, but it uses builtin EC algs
3189# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3190# - accelerate all EC and FFDH algs, disable only RSA
3191# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3192# - this is the reference component of the above
3193# - it still disables RSA, but it uses builtin EC and FFDH algs
3194#
3195# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003196# $1: a boolean value which states if we are testing an accelerated scenario
3197# or not.
3198# $2: a string value which states which components are tested. Allowed values
3199# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003200config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003201 driver_only="$1"
3202 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003203 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003204 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003205
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003206 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003207 # Disable modules that are accelerated
3208 scripts/config.py unset MBEDTLS_ECDSA_C
3209 scripts/config.py unset MBEDTLS_ECDH_C
3210 scripts/config.py unset MBEDTLS_ECJPAKE_C
3211 # Disable ECP module (entirely)
3212 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003213 # Also disable bignum
3214 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003215 fi
3216
3217 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3218 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3219 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3220 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3221
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003222 # RSA support is intentionally disabled on this test because RSA_C depends
3223 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003224 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3225 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 +02003226 scripts/config.py unset MBEDTLS_RSA_C
3227 scripts/config.py unset MBEDTLS_PKCS1_V15
3228 scripts/config.py unset MBEDTLS_PKCS1_V21
3229 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3230 # Also disable key exchanges that depend on RSA
3231 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3232 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3233 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3234 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3235 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3236
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003237 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003238 # When testing ECC only, we disable FFDH support, both from builtin and
3239 # PSA sides, and also disable the key exchanges that depend on DHM.
3240 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3241 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 +01003242 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003243 scripts/config.py unset MBEDTLS_DHM_C
3244 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3245 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3246 else
3247 # When testing ECC and DH instead, we disable DHM and depending key
3248 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003249 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003250 scripts/config.py unset MBEDTLS_DHM_C
3251 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3252 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3253 fi
3254 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003255
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003256 # Restartable feature is not yet supported by PSA. Once it will in
3257 # the future, the following line could be removed (see issues
3258 # 6061, 6332 and following ones)
3259 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3260}
3261
Valerio Setti4e2f2442023-08-15 10:10:26 +02003262# Common helper used by:
3263# - component_test_psa_crypto_config_accel_ecc_no_bignum
3264# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003265#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003266# The goal is to build and test accelerating either:
3267# - ECC only or
3268# - both ECC and FFDH
3269#
3270# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003271# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3272# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003273common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003274 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003275
Valerio Setti5dfaca42023-09-05 08:48:51 +02003276 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003277 if [ "$test_target" = "ECC_DH" ]; then
3278 accel_text="ECC/FFDH"
3279 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003280 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003281 accel_text="ECC"
3282 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003283 fi
3284
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003285 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003286
3287 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003288 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3289 ALG_ECDH \
3290 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003291 $(helper_get_psa_key_type_list "ECC") \
3292 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003293 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003294 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003295 loc_accel_list="$loc_accel_list \
3296 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003297 $(helper_get_psa_key_type_list "DH") \
3298 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003299 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003300
3301 # Configure
3302 # ---------
3303
3304 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003305 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003306 # Disable all the builtin curves. All the required algs are accelerated.
3307 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003308
3309 # Build
3310 # -----
3311
3312 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003313 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3314 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3315 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003316
3317 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3318
Valerio Setti3fe105b2023-10-30 11:08:12 +01003319 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003320
3321 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3322 not grep mbedtls_ecdsa_ library/ecdsa.o
3323 not grep mbedtls_ecdh_ library/ecdh.o
3324 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003325 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003326 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003327 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003328 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003329 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003330
3331 # Run the tests
3332 # -------------
3333
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003334 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003335
Gilles Peskine21570cf2023-12-22 11:49:50 +01003336 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003337
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003338 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003339 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003340}
3341
Valerio Setti4e2f2442023-08-15 10:10:26 +02003342# Common helper used by:
3343# - component_test_psa_crypto_config_reference_ecc_no_bignum
3344# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3345#
3346# The goal is to build and test a reference scenario (i.e. with builtin
3347# components) compared to the ones used in
3348# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3349#
3350# It is meant to be used in conjunction with
3351# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3352# coverage analysis in "analyze_outcomes.py" script.
3353common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003354 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003355
Valerio Setti5dfaca42023-09-05 08:48:51 +02003356 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003357 if [ "$test_target" = "ECC_DH" ]; then
3358 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003359 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003360 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003361 fi
3362
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003363 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003364
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003365 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003366
Gilles Peskine21570cf2023-12-22 11:49:50 +01003367 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003368
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003369 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003370 make test
3371
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003372 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003373 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003374}
3375
Valerio Setti4e2f2442023-08-15 10:10:26 +02003376component_test_psa_crypto_config_accel_ecc_no_bignum () {
3377 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3378}
3379
3380component_test_psa_crypto_config_reference_ecc_no_bignum () {
3381 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3382}
3383
3384component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3385 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3386}
3387
3388component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3389 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3390}
3391
Valerio Settiac6d35f2023-08-04 12:49:11 +02003392# Helper for setting common configurations between:
3393# - component_test_tfm_config_p256m_driver_accel_ec()
3394# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003395common_tfm_config () {
3396 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003397 cp configs/config-tfm.h "$CONFIG_H"
3398 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3399 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003400
Yanray Wang73bb2312023-09-25 11:21:15 +08003401 # Other config adjustment to make the tests pass.
3402 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003403 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003404 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3405 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003406
Yanray Wang73bb2312023-09-25 11:21:15 +08003407 # Config adjustment for better test coverage in our environment.
3408 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003409 #
3410 # Enable filesystem I/O for the benefit of PK parse/write tests.
3411 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3412}
3413
Valerio Settiac6d35f2023-08-04 12:49:11 +02003414# Keep this in sync with component_test_tfm_config() as they are both meant
3415# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003416component_test_tfm_config_p256m_driver_accel_ec () {
3417 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3418
3419 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003420
Dave Rodgman897bb772023-11-15 16:34:20 +00003421 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003422 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003423
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003424 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3425 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003426 not grep mbedtls_ecdh_ library/ecdh.o
3427 not grep mbedtls_ecjpake_ library/ecjpake.o
3428 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3429 not grep mbedtls_ecp_ library/ecp.o
3430 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003431 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003432 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003433 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003434 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003435
Valerio Setti5e18b902023-12-04 12:07:30 +01003436 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3437 # files, so we want to ensure that it has not be re-enabled accidentally.
3438 not grep mbedtls_cipher library/cipher.o
3439
Valerio Settib7e95442023-03-21 11:52:33 +01003440 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003441 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003442 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003443}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003444
Valerio Settiac6d35f2023-08-04 12:49:11 +02003445# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3446# they are both meant to be used in analyze_outcomes.py for driver's coverage
3447# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003448component_test_tfm_config() {
3449 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003450
Dave Rodgman897bb772023-11-15 16:34:20 +00003451 # Disable P256M driver, which is on by default, so that analyze_outcomes
3452 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3453 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3454
Valerio Setti52ba0e32023-08-04 12:43:03 +02003455 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003456 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003457
Dave Rodgman897bb772023-11-15 16:34:20 +00003458 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003459 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003460
Valerio Setti5e18b902023-12-04 12:07:30 +01003461 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3462 # files, so we want to ensure that it has not be re-enabled accidentally.
3463 not grep mbedtls_cipher library/cipher.o
3464
Valerio Setti52ba0e32023-08-04 12:43:03 +02003465 msg "test: TF-M config"
3466 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003467}
3468
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003469# Common helper for component_full_without_ecdhe_ecdsa() and
3470# component_full_without_ecdhe_ecdsa_and_tls13() which:
3471# - starts from the "full" configuration minus the list of symbols passed in
3472# as 1st parameter
3473# - build
3474# - test only TLS (i.e. test_suite_tls and ssl-opt)
3475build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003476 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003477
3478 msg "build: full minus something, test TLS"
3479
3480 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003481 for sym in $symbols_to_disable; do
3482 echo "Disabling $sym"
3483 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003484 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003485
Gilles Peskine21570cf2023-12-22 11:49:50 +01003486 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003487
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003488 msg "test: full minus something, test TLS"
3489 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003490
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003491 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003492 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003493}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003494
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003495component_full_without_ecdhe_ecdsa () {
3496 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003497}
3498
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003499component_full_without_ecdhe_ecdsa_and_tls13 () {
3500 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3501 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003502}
3503
Valerio Setti249b18a2023-06-20 12:08:30 +02003504# This is an helper used by:
3505# - component_test_psa_ecc_key_pair_no_derive
3506# - component_test_psa_ecc_key_pair_no_generate
3507# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3508# enabled, but one. Input arguments are as follows:
3509# - $1 is the key type under test, i.e. ECC/RSA/DH
3510# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003511build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003512 key_type=$1
3513 unset_option=$2
3514 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003515
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003516 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003517 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003518 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3519 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3520
3521 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3522 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003523 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003524
Gilles Peskine21570cf2023-12-22 11:49:50 +01003525 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003526
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003527 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003528 make test
3529}
3530
3531component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003532 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003533}
3534
3535component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003536 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003537}
3538
Pengyu Lve705f572023-12-06 16:38:15 +08003539config_psa_crypto_accel_rsa () {
3540 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003541
Pengyu Lve705f572023-12-06 16:38:15 +08003542 # Start from crypto_full config (no X.509, no TLS)
3543 helper_libtestdriver1_adjust_config "crypto_full"
3544
3545 if [ "$driver_only" -eq 1 ]; then
3546 # Remove RSA support and its dependencies
3547 scripts/config.py unset MBEDTLS_RSA_C
3548 scripts/config.py unset MBEDTLS_PKCS1_V15
3549 scripts/config.py unset MBEDTLS_PKCS1_V21
3550
3551 # We need PEM parsing in the test library as well to support the import
3552 # of PEM encoded RSA keys.
3553 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3554 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3555 fi
3556}
3557
3558component_test_psa_crypto_config_accel_rsa_crypto () {
3559 msg "build: crypto_full with accelerated RSA"
3560
3561 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3562 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3563 KEY_TYPE_RSA_PUBLIC_KEY \
3564 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3565 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3566 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3567 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003568
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003569 # Configure
3570 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003571
Pengyu Lve705f572023-12-06 16:38:15 +08003572 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003573
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003574 # Build
3575 # -----
3576
Pengyu Lve705f572023-12-06 16:38:15 +08003577 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003578 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 +08003579 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003580 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003581
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003582 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003583
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003584 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003585 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003586
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003587 # Run the tests
3588 # -------------
3589
Pengyu Lve705f572023-12-06 16:38:15 +08003590 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003591 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003592}
3593
3594component_test_psa_crypto_config_reference_rsa_crypto () {
3595 msg "build: crypto_full with non-accelerated RSA"
3596
3597 # Configure
3598 # ---------
3599 config_psa_crypto_accel_rsa 0
3600
3601 # Build
3602 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003603 make
Pengyu Lve705f572023-12-06 16:38:15 +08003604
3605 # Run the tests
3606 # -------------
3607 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003608 make test
3609}
3610
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003611# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003612# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003613component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003614 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003615
Valerio Setti4590bc22023-06-13 15:39:23 +02003616 # Create a temporary output file unless there is already one set
3617 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3618 REMOVE_OUTCOME_ON_EXIT="no"
3619 else
3620 REMOVE_OUTCOME_ON_EXIT="yes"
3621 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3622 export MBEDTLS_TEST_OUTCOME_FILE
3623 fi
3624
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003625 # Start from crypto configuration
3626 scripts/config.py crypto
3627
3628 # Remove RSA support and its dependencies
3629 scripts/config.py unset MBEDTLS_PKCS1_V15
3630 scripts/config.py unset MBEDTLS_PKCS1_V21
3631 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3632 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3633 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3634 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3635 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3636 scripts/config.py unset MBEDTLS_RSA_C
3637 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3638
3639 # Enable PSA support
3640 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3641
Valerio Setti01cc88a2023-06-15 11:53:08 +02003642 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003643 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003644 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3645 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3646 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003647
3648 make
3649
Valerio Setti01cc88a2023-06-15 11:53:08 +02003650 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003651 make test
3652
3653 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3654 # performing RSA signature.
3655 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3656 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3657
3658 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3659 rm $MBEDTLS_TEST_OUTCOME_FILE
3660 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003661}
3662
Ronald Cronb2312452021-05-08 14:32:59 +02003663component_test_psa_crypto_config_accel_hash () {
3664 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3665
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003666 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3667 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3668 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003669
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003670 # Configure
3671 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003672
Ronald Cron46ac0652024-03-18 12:39:04 +01003673 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003674 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003675
3676 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003677 scripts/config.py unset MBEDTLS_MD5_C
3678 scripts/config.py unset MBEDTLS_RIPEMD160_C
3679 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003680 scripts/config.py unset MBEDTLS_SHA224_C
3681 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003682 scripts/config.py unset MBEDTLS_SHA384_C
3683 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003684 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003685
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003686 # Build
3687 # -----
3688
3689 helper_libtestdriver1_make_drivers "$loc_accel_list"
3690
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003691 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003692
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003693 # There's a risk of something getting re-enabled via config_psa.h;
3694 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3695 not grep mbedtls_md5 library/md5.o
3696 not grep mbedtls_sha1 library/sha1.o
3697 not grep mbedtls_sha256 library/sha256.o
3698 not grep mbedtls_sha512 library/sha512.o
3699 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003700
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003701 # Run the tests
3702 # -------------
3703
Ronald Cronb2312452021-05-08 14:32:59 +02003704 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3705 make test
3706}
3707
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003708component_test_psa_crypto_config_accel_hash_keep_builtins () {
3709 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3710 # This component ensures that all the test cases for
3711 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3712
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003713 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3714 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3715 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003716
Ronald Cron46ac0652024-03-18 12:39:04 +01003717 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003718 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003719
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003720 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003721
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003722 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003723
3724 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3725 make test
3726}
3727
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003728# Auxiliary function to build config for hashes with and without drivers
3729config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003730 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003731 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003732 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003733 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003734 # disable the built-in implementation of hashes
3735 scripts/config.py unset MBEDTLS_MD5_C
3736 scripts/config.py unset MBEDTLS_RIPEMD160_C
3737 scripts/config.py unset MBEDTLS_SHA1_C
3738 scripts/config.py unset MBEDTLS_SHA224_C
3739 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003740 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003741 scripts/config.py unset MBEDTLS_SHA384_C
3742 scripts/config.py unset MBEDTLS_SHA512_C
3743 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003744 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003745 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003746}
3747
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003748# Note that component_test_psa_crypto_config_reference_hash_use_psa
3749# is related to this component and both components need to be kept in sync.
3750# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003751component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003752 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003753
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003754 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3755 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3756 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003757
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003758 # Configure
3759 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003760
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003761 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003762
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003763 # Build
3764 # -----
3765
3766 helper_libtestdriver1_make_drivers "$loc_accel_list"
3767
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003768 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003769
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003770 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003771 # 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 +02003772 not grep mbedtls_md5 library/md5.o
3773 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003774 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003775 not grep mbedtls_sha512 library/sha512.o
3776 not grep mbedtls_ripemd160 library/ripemd160.o
3777
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003778 # Run the tests
3779 # -------------
3780
Gilles Peskine14302ed2023-07-19 19:30:04 +02003781 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003782 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003783
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003784 # This is mostly useful so that we can later compare outcome files with
3785 # the reference config in analyze_outcomes.py, to check that the
3786 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003787 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003788 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003789
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003790 # This is to make sure all ciphersuites are exercised, but we don't need
3791 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003792 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003793 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003794}
3795
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003796# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3797# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3798# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3799# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003800component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003801 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003802
3803 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003804
Gilles Peskine21570cf2023-12-22 11:49:50 +01003805 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003806
Gilles Peskine14302ed2023-07-19 19:30:04 +02003807 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003808 make test
3809
Gilles Peskine14302ed2023-07-19 19:30:04 +02003810 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003811 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003812}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003813
Valerio Setti8eb310c2024-01-22 16:22:57 +01003814# Auxiliary function to build config for hashes with and without drivers
3815config_psa_crypto_hmac_use_psa () {
3816 driver_only="$1"
3817 # start with config full for maximum coverage (also enables USE_PSA)
3818 helper_libtestdriver1_adjust_config "full"
3819
Valerio Setticd89b0b2024-01-24 14:24:55 +01003820 if [ "$driver_only" -eq 1 ]; then
3821 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3822 # is still enabled though (for ENTROPY_C among others).
3823 scripts/config.py unset MBEDTLS_MD_C
3824 # Disable also the builtin hashes since they are supported by the driver
3825 # and MD module is able to perform PSA dispathing.
3826 scripts/config.py unset-all MBEDTLS_SHA
3827 scripts/config.py unset MBEDTLS_MD5_C
3828 scripts/config.py unset MBEDTLS_RIPEMD160_C
3829 fi
3830
Valerio Setti8eb310c2024-01-22 16:22:57 +01003831 # Direct dependencies of MD_C. We disable them also in the reference
3832 # component to work with the same set of features.
3833 scripts/config.py unset MBEDTLS_PKCS7_C
3834 scripts/config.py unset MBEDTLS_PKCS5_C
3835 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3836 scripts/config.py unset MBEDTLS_HKDF_C
3837 # Dependencies of HMAC_DRBG
3838 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3840}
3841
3842component_test_psa_crypto_config_accel_hmac() {
3843 msg "test: full with accelerated hmac"
3844
3845 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3846 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3847 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3848 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3849
3850 # Configure
3851 # ---------
3852
3853 config_psa_crypto_hmac_use_psa 1
3854
Valerio Setti8eb310c2024-01-22 16:22:57 +01003855 # Build
3856 # -----
3857
3858 helper_libtestdriver1_make_drivers "$loc_accel_list"
3859
3860 helper_libtestdriver1_make_main "$loc_accel_list"
3861
3862 # Ensure that built-in support for HMAC is disabled.
3863 not grep mbedtls_md_hmac library/md.o
3864
3865 # Run the tests
3866 # -------------
3867
3868 msg "test: full with accelerated hmac"
3869 make test
3870}
3871
3872component_test_psa_crypto_config_reference_hmac() {
3873 msg "test: full without accelerated hmac"
3874
3875 config_psa_crypto_hmac_use_psa 0
3876
3877 make
3878
3879 msg "test: full without accelerated hmac"
3880 make test
3881}
3882
Valerio Setti9da01a72023-12-18 17:38:18 +01003883component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003884 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003885
Valerio Setti9da01a72023-12-18 17:38:18 +01003886 # Albeit this components aims at accelerating DES which should only support
3887 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3888 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003889 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3890 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3891 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003892
Valerio Setti9da01a72023-12-18 17:38:18 +01003893 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3894 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3895 # of this component. This limitation will be addressed by #8598.
3896
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003897 # Configure
3898 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003899
Valerio Setti9a427302023-10-17 11:40:42 +02003900 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003901 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003902
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003903 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003904 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3905 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3906 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3907 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3908 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3909 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3910 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003911 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003912
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003913 # Build
3914 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003915
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003916 helper_libtestdriver1_make_drivers "$loc_accel_list"
3917
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003918 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003919
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003920 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003921 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003922
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003923 # Run the tests
3924 # -------------
3925
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003926 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003927 make test
3928}
3929
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003930component_test_psa_crypto_config_accel_aead () {
3931 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3932
Valerio Setti3f02bb72023-10-02 15:57:33 +02003933 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3934 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003935
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003936 # Configure
3937 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003938
Valerio Setti3f02bb72023-10-02 15:57:33 +02003939 # Start from full config
3940 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003941
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003942 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003943 scripts/config.py unset MBEDTLS_GCM_C
3944 scripts/config.py unset MBEDTLS_CCM_C
3945 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003946
Valerio Settia50b89e2023-11-08 15:58:47 +01003947 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3948 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003949
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003950 # Build
3951 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003952
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003953 helper_libtestdriver1_make_drivers "$loc_accel_list"
3954
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003955 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003956
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003957 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003958 not grep mbedtls_ccm library/ccm.o
3959 not grep mbedtls_gcm library/gcm.o
3960 not grep mbedtls_chachapoly library/chachapoly.o
3961
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003962 # Run the tests
3963 # -------------
3964
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003965 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3966 make test
3967}
3968
Valerio Settib680fc42023-10-13 09:29:37 +02003969# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003970# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3971# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3972common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003973 # Start from the full config
3974 helper_libtestdriver1_adjust_config "full"
3975
Valerio Settib680fc42023-10-13 09:29:37 +02003976 scripts/config.py unset MBEDTLS_NIST_KW_C
3977}
3978
Valerio Settib6b301f2023-10-04 12:05:05 +02003979# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003980# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3981# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003982# are meant to be used together in analyze_outcomes.py script in order to test
3983# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003984component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3985 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003986
Valerio Settiad8b7f02023-10-25 12:39:50 +02003987 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 +01003988 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003989 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003990 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3991
3992 # Configure
3993 # ---------
3994
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003995 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003996
3997 # Disable the things that are being accelerated
3998 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3999 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4000 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4001 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4002 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4003 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4004 scripts/config.py unset MBEDTLS_GCM_C
4005 scripts/config.py unset MBEDTLS_CCM_C
4006 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004007 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004008 scripts/config.py unset MBEDTLS_DES_C
4009 scripts/config.py unset MBEDTLS_AES_C
4010 scripts/config.py unset MBEDTLS_ARIA_C
4011 scripts/config.py unset MBEDTLS_CHACHA20_C
4012 scripts/config.py unset MBEDTLS_CAMELLIA_C
4013
Valerio Settiec9b2582023-11-08 16:50:54 +01004014 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4015 # does not depend on it.
4016 scripts/config.py unset MBEDTLS_CIPHER_C
4017
Valerio Settib6b301f2023-10-04 12:05:05 +02004018 # Build
4019 # -----
4020
4021 helper_libtestdriver1_make_drivers "$loc_accel_list"
4022
4023 helper_libtestdriver1_make_main "$loc_accel_list"
4024
4025 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004026 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004027 not grep mbedtls_des library/des.o
4028 not grep mbedtls_aes library/aes.o
4029 not grep mbedtls_aria library/aria.o
4030 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004031 not grep mbedtls_ccm library/ccm.o
4032 not grep mbedtls_gcm library/gcm.o
4033 not grep mbedtls_chachapoly library/chachapoly.o
4034 not grep mbedtls_cmac library/cmac.o
4035
4036 # Run the tests
4037 # -------------
4038
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004039 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004040 make test
Valerio Settif9414552023-11-09 10:43:20 +01004041
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004042 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004043 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004044
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004045 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004046 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004047}
4048
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004049component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4050 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4051 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004052
Gilles Peskine21570cf2023-12-22 11:49:50 +01004053 make
Valerio Settif9414552023-11-09 10:43:20 +01004054
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004055 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004056 make test
Valerio Settif9414552023-11-09 10:43:20 +01004057
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004058 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004059 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004060
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004061 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004062 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004063}
4064
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004065common_block_cipher_dispatch() {
4066 TEST_WITH_DRIVER="$1"
4067
4068 # Start from the full config
4069 helper_libtestdriver1_adjust_config "full"
4070
4071 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4072 # Disable key types that are accelerated (there is no legacy equivalent
4073 # symbol for ECB)
4074 scripts/config.py unset MBEDTLS_AES_C
4075 scripts/config.py unset MBEDTLS_ARIA_C
4076 scripts/config.py unset MBEDTLS_CAMELLIA_C
4077 fi
4078
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004079 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004080 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004081 # Keep this also in the reference component in order to skip the same tests
4082 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004083 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4084 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4085 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4086 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4087 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4088 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4089 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004090
4091 # Disable direct dependency on AES_C
4092 scripts/config.py unset MBEDTLS_NIST_KW_C
4093
4094 # Prevent the cipher module from using deprecated PSA path. The reason is
4095 # that otherwise there will be tests relying on "aes_info" (defined in
4096 # "cipher_wrap.c") whose functions are not available when AES_C is
4097 # not defined. ARIA and Camellia are not a problem in this case because
4098 # the PSA path is not tested for these key types.
4099 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4100}
4101
Valerio Settif8e6cba2023-12-12 11:53:39 +01004102component_test_full_block_cipher_psa_dispatch () {
4103 msg "build: full + PSA dispatch in block_cipher"
4104
4105 loc_accel_list="ALG_ECB_NO_PADDING \
4106 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4107
4108 # Configure
4109 # ---------
4110
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004111 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004112
Valerio Settif8e6cba2023-12-12 11:53:39 +01004113 # Build
4114 # -----
4115
4116 helper_libtestdriver1_make_drivers "$loc_accel_list"
4117
4118 helper_libtestdriver1_make_main "$loc_accel_list"
4119
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004120 # Make sure disabled components were not re-enabled by accident (additive
4121 # config)
4122 not grep mbedtls_aes_ library/aes.o
4123 not grep mbedtls_aria_ library/aria.o
4124 not grep mbedtls_camellia_ library/camellia.o
4125
Valerio Settif8e6cba2023-12-12 11:53:39 +01004126 # Run the tests
4127 # -------------
4128
4129 msg "test: full + PSA dispatch in block_cipher"
4130 make test
4131}
4132
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004133# This is the reference component of component_test_full_block_cipher_psa_dispatch
4134component_test_full_block_cipher_legacy_dispatch () {
4135 msg "build: full + legacy dispatch in block_cipher"
4136
4137 common_block_cipher_dispatch 0
4138
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004139 make
4140
4141 msg "test: full + legacy dispatch in block_cipher"
4142 make test
4143}
4144
Gilles Peskine36dea152023-07-20 22:19:45 +02004145component_test_aead_chachapoly_disabled() {
4146 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004147 scripts/config.py full
4148 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004149 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004150 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004151
Gilles Peskine36dea152023-07-20 22:19:45 +02004152 msg "test: full minus CHACHAPOLY"
4153 make test
4154}
4155
4156component_test_aead_only_ccm() {
4157 msg "build: full minus CHACHAPOLY and GCM"
4158 scripts/config.py full
4159 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4160 scripts/config.py unset MBEDTLS_GCM_C
4161 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4162 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004163 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004164
4165 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004166 make test
4167}
4168
Ronald Crone501d0e2023-07-10 08:31:19 +02004169component_test_ccm_aes_sha256() {
4170 msg "build: CCM + AES + SHA256 configuration"
4171
Ronald Cron7612d8c2023-07-20 10:03:54 +02004172 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004173 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004174
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004175 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004176
4177 msg "test: CCM + AES + SHA256 configuration"
4178 make test
4179}
4180
John Durkopd0321952020-10-29 21:37:36 -07004181# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004182component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004183 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004184 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004185 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004186 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004187 scripts/config.py unset MBEDTLS_ECDH_C
4188 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4189 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4190 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4191 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4192 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4193 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004194 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004195}
4196
4197# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004198component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004199 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004200 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004201 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004202 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004203 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004204 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004205}
4206
4207# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004208component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004209 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004210 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004211 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
4212 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004213 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4214 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004215 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004216 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004217}
4218
John Durkop1b7ee052020-11-27 08:51:22 -08004219# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4220component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004221 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004222 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004223 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004224 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004225 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4226 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4227 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4228 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4229 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4230 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4231 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004232 scripts/config.py unset MBEDTLS_LMS_C
4233 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004234 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004235 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004236}
4237
4238# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4239component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004240 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004241 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004242 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004243 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004244 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4245 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4246 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4247 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4248 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4249 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4250 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004251 scripts/config.py unset MBEDTLS_LMS_C
4252 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004253 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004254 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004255}
4256
4257# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4258component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004259 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004260 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004261 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004262 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004263 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4264 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4265 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4266 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4267 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4268 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4269 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004270 scripts/config.py unset MBEDTLS_LMS_C
4271 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004272 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004273 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004274}
4275
4276# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4277component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004278 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004279 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004280 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004281 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004282 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4283 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4284 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4285 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4286 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4287 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004288 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004289 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004290}
4291
4292# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4293component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004294 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004295 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004296 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004297 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004298 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4299 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4300 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4301 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4302 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4303 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004304 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004305 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004306}
4307
4308# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4309component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004310 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004311 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004312 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004313 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004314 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4315 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4316 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4317 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4318 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4319 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004320 scripts/config.py unset MBEDTLS_LMS_C
4321 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004322 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004323 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004324}
4325
4326# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4327component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004328 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004329 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004330 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004331 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004332 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4333 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4334 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4335 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4336 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4337 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4338 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004339 scripts/config.py unset MBEDTLS_LMS_C
4340 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004341 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004342 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004343}
4344
John Durkopd0321952020-10-29 21:37:36 -07004345# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004346component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004347 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_CRYPT + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopd0321952020-10-29 21:37:36 -07004348 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004349 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004350 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004351 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4352 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4353 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4354 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004355 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004356 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004357}
4358
4359# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004360component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004361 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_SIGN + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004362 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004363 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004364 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004365 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4366 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4367 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4368 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004369 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004370 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004371}
4372
4373# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004374component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004375 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_OAEP + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004376 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004377 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004378 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004379 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4380 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4381 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4382 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004383 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004384 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004385}
4386
4387# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004388component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004389 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PSS + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004390 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004391 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004392 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004393 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4394 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4395 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4396 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004397 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004398 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004399}
4400
4401# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004402component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004403 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_xxx + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004404 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004405 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004406 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004407 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4408 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4409 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4410 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4411 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004412 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004413 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004414}
4415
4416# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004417component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004418 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004419 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004420 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004421 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004422 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4423 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004424 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004425 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004426}
4427
Dave Rodgmanc164c072023-06-28 09:43:23 +01004428
Dave Rodgman904c5892023-06-28 17:36:02 +01004429support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004430 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004431}
4432
Dave Rodgman904c5892023-06-28 17:36:02 +01004433component_build_tfm_armcc() {
4434 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004435 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004436
Dave Rodgman88651c42023-06-29 12:35:51 +01004437 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004438 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 +01004439}
4440
4441component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004442 # Check that the TF-M configuration can build cleanly with various
4443 # warning flags enabled. We don't build or run tests, since the
4444 # TF-M configuration needs a TF-M platform. A tweaked version of
4445 # the configuration that works on mainstream platforms is in
4446 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004447 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004448
Dave Rodgman88651c42023-06-29 12:35:51 +01004449 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004450 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 +01004451
Dave Rodgman904c5892023-06-28 17:36:02 +01004452 msg "build: TF-M config, gcc native build"
4453 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004454 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 +01004455}
4456
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004457# Test that the given .o file builds with all (valid) combinations of the given options.
4458#
4459# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4460#
4461# The validator function is the name of a function to validate the combination of options.
4462# It may be "" if all combinations are valid.
4463# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004464# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004465build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004466 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004467 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004468 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004469 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004470 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004471
Dave Rodgman42436102023-10-03 15:47:05 +01004472 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004473 for opt in "${options[@]}"; do
4474 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004475 done
4476
4477 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004478 cd $(dirname ${file})
4479 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004480
Dave Rodgman920343a2023-10-01 18:41:09 +01004481 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004482 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 +01004483
Dave Rodgman42436102023-10-03 15:47:05 +01004484 # Extract the command generated by the Makefile to build the target file.
4485 # This ensures that we have any include paths, macro definitions, etc
4486 # that may be applied by make.
4487 # 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 +01004488 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004489
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004490 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004491 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004492
Dave Rodgman28e38d82023-10-04 11:50:30 +01004493 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004494 source_file=${file%.o}.c
4495
4496 targets=0
4497 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004498
Dave Rodgman28e38d82023-10-04 11:50:30 +01004499 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004500 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004501 # each bit of $i is used to determine if options[i] will be set or not
4502 target="t"
4503 clang_args=""
4504 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004505 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004506 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004507 clang_args="${clang_args} ${opt}"
4508 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004509 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004510 done
4511
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004512 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004513 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004514 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004515 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004516
Dave Rodgman28e38d82023-10-04 11:50:30 +01004517 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004518 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004519 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004520 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004521
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004522 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004523
Dave Rodgman920343a2023-10-01 18:41:09 +01004524 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004525 make -s -f ${makefile} build_test_config_combos
4526 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004527
4528 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004529 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004530}
4531
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004532validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004533 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4534 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004535 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004536 fi
4537 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4538 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004539 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004540 fi
4541 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004542 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004543}
4544
4545component_build_aes_variations() {
4546 # 18s - around 90ms per clang invocation on M1 Pro
4547 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004548 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004549 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004550
Yanray Wangbc29aef2023-11-06 11:08:17 +08004551 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004552 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004553
Dave Rodgman42436102023-10-03 15:47:05 +01004554 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004555 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4556 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4557 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4558 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004559
4560 cd "$MBEDTLS_ROOT_DIR"
4561 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4562
Yanray Wang42be1ba2023-11-23 14:28:47 +08004563 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004564 # manually set or unset those configurations to check
4565 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004566 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4567 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4568 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4569 scripts/config.py unset MBEDTLS_DES_C
4570 scripts/config.py unset MBEDTLS_NIST_KW_C
4571 build_test_config_combos library/aes.o validate_aes_config_variations \
4572 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4573 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4574 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4575 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004576}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004577
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004578component_test_no_platform () {
4579 # Full configuration build, without platform support, file IO and net sockets.
4580 # This should catch missing mbedtls_printf definitions, and by disabling file
4581 # IO, it should catch missing '#include <stdio.h>'
4582 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004583 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004584 scripts/config.py unset MBEDTLS_PLATFORM_C
4585 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004586 scripts/config.py unset MBEDTLS_FS_IO
4587 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004588 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004589 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004590 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004591 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004592 # to re-enable platform integration features otherwise disabled in C99 builds
4593 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004594 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004595}
Gilles Peskine7c652162017-12-11 00:01:40 +01004596
4597component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004598 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004599 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4600 scripts/config.py full
4601 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004602 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4603 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4604 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4605 make
4606}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004607
Gilles Peskine8f073122018-11-27 15:58:47 +01004608component_build_no_ssl_srv () {
4609 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004610 scripts/config.py full
4611 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004612 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004613}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004614
Gilles Peskine8f073122018-11-27 15:58:47 +01004615component_build_no_ssl_cli () {
4616 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004617 scripts/config.py full
4618 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004619 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004620}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004621
Gilles Peskine8f073122018-11-27 15:58:47 +01004622component_build_no_sockets () {
4623 # Note, C99 compliance can also be tested with the sockets support disabled,
4624 # as that requires a POSIX platform (which isn't the same as C99).
4625 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004626 scripts/config.py full
4627 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4628 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4629 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4630}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004631
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004632component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004633 msg "build: default config with memory buffer allocator and backtrace enabled"
4634 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4635 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4636 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004637 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004638 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004639 make
4640
4641 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4642 make test
4643}
4644
4645component_test_memory_buffer_allocator () {
4646 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004647 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4648 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004649 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004650 make
4651
4652 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4653 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004654
4655 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4656 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004657 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004658}
4659
Gilles Peskine8f073122018-11-27 15:58:47 +01004660component_test_no_max_fragment_length () {
4661 # Run max fragment length tests with MFL disabled
4662 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004663 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004664 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004665 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004666
Gilles Peskine8f073122018-11-27 15:58:47 +01004667 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004668 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004669}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004670
Hanno Becker545ced42019-02-19 11:10:48 +00004671component_test_asan_remove_peer_certificate () {
4672 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004673 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004674 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004675 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004676 make
4677
4678 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4679 make test
4680
4681 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004682 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004683
4684 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004685 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004686
4687 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004688 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004689}
4690
Gilles Peskine8f073122018-11-27 15:58:47 +01004691component_test_no_max_fragment_length_small_ssl_out_content_len () {
4692 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004693 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4694 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4695 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004696 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004697 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004698
Gilles Peskine8f073122018-11-27 15:58:47 +01004699 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004700 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004701
4702 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004703 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004704}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004705
Darryl Greenaad82f92019-12-02 10:53:11 +00004706component_test_variable_ssl_in_out_buffer_len () {
4707 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4708 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004709 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004710 make
4711
4712 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4713 make test
4714
4715 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004716 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004717
4718 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004719 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004720}
4721
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004722component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004723 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004724 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004725
Dave Rodgman17127e92023-12-14 16:42:48 +00004726 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004727 make
4728
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004729 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004730 make test
4731
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004732 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004733 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004734
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004735 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004736 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004737}
4738
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004739component_test_ssl_alloc_buffer_and_mfl () {
4740 msg "build: default config with memory buffer allocator and MFL extension"
4741 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4742 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4743 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4744 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4745 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004746 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004747 make
4748
4749 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4750 make test
4751
4752 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 +02004753 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004754}
4755
Gilles Peskine636c26a2020-03-04 20:46:15 +01004756component_test_when_no_ciphersuites_have_mac () {
4757 msg "build: when no ciphersuites have MAC"
4758 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004759 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004760 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004761 make
4762
4763 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4764 make test
4765
4766 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004767 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004768}
4769
Raoul Strackxa4e86142020-06-15 17:03:13 +02004770component_test_no_date_time () {
4771 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4772 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004773 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004774 make
4775
4776 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4777 make test
4778}
4779
Gilles Peskine8f073122018-11-27 15:58:47 +01004780component_test_platform_calloc_macro () {
4781 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004782 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4783 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4784 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004785 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004786 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004787
Gilles Peskine8f073122018-11-27 15:58:47 +01004788 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4789 make test
4790}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004791
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004792component_test_malloc_0_null () {
4793 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004794 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004795 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 +02004796
4797 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4798 make test
4799
4800 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4801 # Just the calloc selftest. "make test" ran the others as part of the
4802 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004803 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004804
4805 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4806 # Run a subset of the tests. The choice is a balance between coverage
4807 # and time (including time indirectly wasted due to flaky tests).
4808 # The current choice is to skip tests whose description includes
4809 # "proxy", which is an approximation of skipping tests that use the
4810 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004811 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004812}
4813
Dave Rodgman6a08b682023-06-19 11:51:33 +01004814support_test_aesni() {
4815 # Check that gcc targets x86_64 (we can build AESNI), and check for
4816 # AESNI support on the host (we can run AESNI).
4817 #
4818 # The name of this function is possibly slightly misleading, but needs to align
4819 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004820 #
4821 # In principle 32-bit x86 can support AESNI, but our implementation does not
4822 # support 32-bit x86, so we check for x86-64.
4823 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004824 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4825 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004826 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004827}
4828
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004829component_test_aesni () { # ~ 60s
4830 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4831 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4832 #
4833 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4834 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4835 # exercise the plain C impl).
4836
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004837 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004838 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004839 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004840 scripts/config.py set MBEDTLS_HAVE_ASM
4841
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004842 # test the intrinsics implementation
4843 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004844 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004845 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004846 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004847 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004848
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004849 # test the asm implementation
4850 msg "AES tests, test assembly"
4851 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004852 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004853 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004854 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004855
4856 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004857 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004858 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004859 msg "AES tests, plain C"
4860 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004861 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004862 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004863 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004864 not grep -q "AES note: using AESNI" ./programs/test/selftest
4865 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004866
4867 # test the intrinsics implementation
4868 scripts/config.py set MBEDTLS_AESNI_C
4869 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4870 msg "AES tests, test AESNI only"
4871 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004872 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004873 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4874 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004875 grep -q "AES note: using AESNI" ./programs/test/selftest
4876 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004877}
4878
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004879component_test_sha3_variations() {
4880 msg "sha3 loop unroll variations"
4881
4882 # define minimal config sufficient to test SHA3
4883 cat > include/mbedtls/mbedtls_config.h << END
4884 #define MBEDTLS_SELF_TEST
4885 #define MBEDTLS_SHA3_C
4886END
4887
4888 msg "all loops unrolled"
4889 make clean
4890 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"
4891 ./tests/test_suite_shax
4892
4893 msg "all loops rolled up"
4894 make clean
4895 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"
4896 ./tests/test_suite_shax
4897}
4898
Jerry Yub6d39c22023-08-16 15:11:48 +08004899support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004900 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004901}
4902
4903component_test_aesni_m32 () { # ~ 60s
4904 # This tests are duplicated from component_test_aesni for i386 target
4905 #
4906 # AESNI intrinsic code supports i386 and assembly code does not support it.
4907
4908 msg "build: default config with different AES implementations"
4909 scripts/config.py set MBEDTLS_AESNI_C
4910 scripts/config.py set MBEDTLS_PADLOCK_C
4911 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4912 scripts/config.py set MBEDTLS_HAVE_ASM
4913
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004914 # test the intrinsics implementation with gcc
4915 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004916 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004917 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004918 # check that we built intrinsics - this should be used by default when supported by the compiler
4919 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4920 grep -q "AES note: using AESNI" ./programs/test/selftest
4921 grep -q "AES note: built-in implementation." ./programs/test/selftest
4922 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4923 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4924
4925 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004926 scripts/config.py unset MBEDTLS_PADLOCK_C
4927 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4928 msg "AES tests, test AESNI only"
4929 make clean
4930 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4931 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4932 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4933 grep -q "AES note: using AESNI" ./programs/test/selftest
4934 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4935 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4936 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4937}
4938
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004939support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004940 # clang >= 4 is required to build with target attributes
4941 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004942}
4943
4944component_test_aesni_m32_clang() {
4945
4946 scripts/config.py set MBEDTLS_AESNI_C
4947 scripts/config.py set MBEDTLS_PADLOCK_C
4948 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4949 scripts/config.py set MBEDTLS_HAVE_ASM
4950
4951 # test the intrinsics implementation with clang
4952 msg "AES tests, test intrinsics (clang)"
4953 make clean
4954 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4955 # check that we built intrinsics - this should be used by default when supported by the compiler
4956 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4957 grep -q "AES note: using AESNI" ./programs/test/selftest
4958 grep -q "AES note: built-in implementation." ./programs/test/selftest
4959 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4960 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4961}
4962
Jerry Yu193cbc02023-08-03 17:06:29 +08004963# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4964component_build_aes_aesce_armcc () {
4965 msg "Build: AESCE test on arm64 platform without plain C."
4966 scripts/config.py baremetal
4967
4968 # armc[56] don't support SHA-512 intrinsics
4969 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4970
4971 # Stop armclang warning about feature detection for A64_CRYPTO.
4972 # With this enabled, the library does build correctly under armclang,
4973 # but in baremetal builds (as tested here), feature detection is
4974 # unavailable, and the user is notified via a #warning. So enabling
4975 # this feature would prevent us from building with -Werror on
4976 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004977 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004978 scripts/config.py set MBEDTLS_HAVE_ASM
4979
4980 msg "AESCE, build with default configuration."
4981 scripts/config.py set MBEDTLS_AESCE_C
4982 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4983 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4984
4985 msg "AESCE, build AESCE only"
4986 scripts/config.py set MBEDTLS_AESCE_C
4987 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4988 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4989}
4990
Dave Rodgman0c584032023-10-08 12:26:54 +01004991support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004992 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004993 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004994}
4995
4996component_build_aes_armce () {
4997 # Test variations of AES with Armv8 crypto extensions
4998 scripts/config.py set MBEDTLS_AESCE_C
4999 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5000
5001 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01005002 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005003
5004 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5005 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5006
5007 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5008 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5009
Dave Rodgman5e419372023-10-23 15:30:20 +01005010 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01005011
Dave Rodgman5e419372023-10-23 15:30:20 +01005012 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
5013 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005014
Dave Rodgman5e419372023-10-23 15:30:20 +01005015 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5016 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01005017
Dave Rodgman5e419372023-10-23 15:30:20 +01005018 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5019 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01005020
5021 # test for presence of AES instructions
5022 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5023 msg "clang, test A32 crypto instructions built"
5024 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5025 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5026 msg "clang, test T32 crypto instructions built"
5027 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5028 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5029 msg "clang, test aarch64 crypto instructions built"
5030 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5031 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
5032
5033 # test for absence of AES instructions
5034 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
5035 scripts/config.py unset MBEDTLS_AESCE_C
5036 msg "clang, test A32 crypto instructions not built"
5037 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5038 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5039 msg "clang, test T32 crypto instructions not built"
5040 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5041 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5042 msg "clang, test aarch64 crypto instructions not built"
5043 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5044 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01005045}
5046
Dave Rodgman9ed18532023-10-05 00:06:47 +01005047support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00005048 # clang >= 4 is required to build with SHA extensions
5049 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01005050}
5051
Dave Rodgmand9e80832023-10-04 17:17:46 +01005052component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01005053 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005054
5055
5056 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01005057 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005058 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
5059 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5060 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
5061 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5062 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005063
Dave Rodgmand9e80832023-10-04 17:17:46 +01005064
Dave Rodgman94a634d2023-10-10 12:59:29 +01005065 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005066 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005067 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
5068 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5069 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005070
Dave Rodgman5b89c552023-10-10 14:59:02 +01005071 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005072 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
5073 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5074 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01005075
Dave Rodgmancd654002023-10-05 09:40:07 +01005076
Dave Rodgman94a634d2023-10-10 12:59:29 +01005077 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005078 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005079 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
5080 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
5081 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
5082 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5083 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005084
Dave Rodgmancd654002023-10-05 09:40:07 +01005085
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005086 # examine the disassembly for presence of SHA instructions
5087 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5088 scripts/config.py set ${opt}
5089 msg "${opt} clang, test A32 crypto instructions built"
5090 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5091 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5092
5093 msg "${opt} clang, test T32 crypto instructions built"
5094 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5095 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5096
5097 msg "${opt} clang, test aarch64 crypto instructions built"
5098 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5099 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5100 scripts/config.py unset ${opt}
5101 done
5102
5103
5104 # examine the disassembly for absence of SHA instructions
5105 msg "clang, test A32 crypto instructions not built"
5106 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5107 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5108
5109 msg "clang, test T32 crypto instructions not built"
5110 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5111 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5112
5113 msg "clang, test aarch64 crypto instructions not built"
5114 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5115 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005116}
5117
Jerry Yuc935aa62023-08-03 17:08:27 +08005118# For timebeing, no VIA Padlock platform available.
5119component_build_aes_via_padlock () {
5120
5121 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005122 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005123 scripts/config.py set MBEDTLS_PADLOCK_C
5124 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005125 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005126 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005127
5128}
5129
5130support_build_aes_via_padlock_only () {
5131 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5132 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5133 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5134}
5135
Jerry Yu193cbc02023-08-03 17:06:29 +08005136support_build_aes_aesce_armcc () {
5137 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005138}
5139
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005140component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005141 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005142 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005143 scripts/config.py unset MBEDTLS_PADLOCK_C
5144
Dave Rodgmand8d64512023-12-19 12:20:21 +00005145 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005146
5147 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5148 make test
5149}
5150
5151component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5152 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5153 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005154 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5155 scripts/config.py unset MBEDTLS_PADLOCK_C
5156
Hanno Becker83ebf782017-07-07 12:29:15 +01005157 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005158
5159 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005160 make test
5161}
Gilles Peskine8f073122018-11-27 15:58:47 +01005162
Hanno Becker83ebf782017-07-07 12:29:15 +01005163component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005164 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5165 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5166 scripts/config.py unset MBEDTLS_PADLOCK_C
5167 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005168 scripts/config.py unset MBEDTLS_AESCE_C
5169
Dave Rodgmand8d64512023-12-19 12:20:21 +00005170 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005171
5172 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005173 make test
5174
5175 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5176 programs/test/selftest
5177}
5178
Matthias Schulz0767fda2024-02-07 10:46:28 +01005179component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005180 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5181 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005182 scripts/config.py unset MBEDTLS_PADLOCK_C
5183 scripts/config.py unset MBEDTLS_AESNI_C
5184 scripts/config.py unset MBEDTLS_AESCE_C
5185
5186 make CFLAGS='-O2 -Werror -Wall -Wextra'
5187
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005188 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005189 make test
5190}
5191
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005192component_test_aes_fewer_tables () {
5193 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005194 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005195 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005196
Gilles Peskine7c652162017-12-11 00:01:40 +01005197 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005198 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005199}
5200
5201component_test_aes_rom_tables () {
5202 msg "build: default config with AES_ROM_TABLES enabled"
5203 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005204 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005205
5206 msg "test: AES_ROM_TABLES"
5207 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005208}
5209
Gilles Peskine14c3c062018-01-29 21:25:12 +01005210component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005211 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5212 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5213 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005214 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005215
Gilles Peskine8f073122018-11-27 15:58:47 +01005216 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5217 make test
5218}
5219
Yanray Wang49cd4b52023-11-10 11:58:37 +08005220# helper for common_block_cipher_no_decrypt() which:
5221# - enable/disable the list of config options passed from -s/-u respectively.
5222# - build
5223# - test for tests_suite_xxx
5224# - selftest
5225#
5226# Usage: helper_block_cipher_no_decrypt_build_test
5227# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5228# Options: -s set_opts the list of config options to enable
5229# -u unset_opts the list of config options to disable
5230# -c cflags the list of options passed to CFLAGS
5231# -l ldflags the list of options passed to LDFLAGS
5232helper_block_cipher_no_decrypt_build_test () {
5233 while [ $# -gt 0 ]; do
5234 case "$1" in
5235 -s)
5236 shift; local set_opts="$1";;
5237 -u)
5238 shift; local unset_opts="$1";;
5239 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005240 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005241 -l)
5242 shift; local ldflags="$1";;
5243 esac
5244 shift
5245 done
5246 set_opts="${set_opts:-}"
5247 unset_opts="${unset_opts:-}"
5248 cflags="${cflags:-}"
5249 ldflags="${ldflags:-}"
5250
Yanray Wangb2d6e522023-11-13 16:57:47 +08005251 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5252 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005253
5254 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5255 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005256 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005257
5258 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5259 not grep mbedtls_aes_setkey_dec library/aes.o
5260 not grep mbedtls_aria_setkey_dec library/aria.o
5261 not grep mbedtls_camellia_setkey_dec library/camellia.o
5262 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5263 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005264 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5265 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005266
5267 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5268 make test
5269
5270 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5271 programs/test/selftest
5272}
5273
5274# This is a common configuration function used in:
5275# - component_test_block_cipher_no_decrypt_aesni_legacy()
5276# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5277# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5278# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5279# on x86.
5280common_block_cipher_no_decrypt () {
5281 # test AESNI intrinsics
5282 helper_block_cipher_no_decrypt_build_test \
5283 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005284 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005285
5286 # test AESNI assembly
5287 helper_block_cipher_no_decrypt_build_test \
5288 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005289 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005290
5291 # test AES C implementation
5292 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005293 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005294
5295 # test AESNI intrinsics for i386 target
5296 helper_block_cipher_no_decrypt_build_test \
5297 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005298 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005299 -l "-m32"
5300}
5301
Yanray Wang3ae11992023-11-13 17:32:09 +08005302# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5303# usage: 0: no PSA crypto configuration
5304# 1: use PSA crypto configuration
5305config_block_cipher_no_decrypt () {
5306 use_psa=$1
5307
Yanray Wang66111392023-10-31 18:54:54 +08005308 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005309 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5310 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005311 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005312 scripts/config.py unset MBEDTLS_NIST_KW_C
5313
Yanray Wang3ae11992023-11-13 17:32:09 +08005314 if [ "$use_psa" -eq 1 ]; then
5315 # Enable support for cryptographic mechanisms through the PSA API.
5316 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5317 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5318 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5319 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5320 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5321 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5322 fi
5323}
5324
5325component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005326 # This consistently causes an llvm crash on clang 3.8, so use gcc
5327 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005328 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005329 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005330}
5331
Yanray Wangf1496402023-11-01 18:55:13 +08005332component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005333 # This consistently causes an llvm crash on clang 3.8, so use gcc
5334 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005335 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005336 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005337}
5338
Yanray Wang66111392023-10-31 18:54:54 +08005339support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005340 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005341}
5342
Yanray Wang66111392023-10-31 18:54:54 +08005343component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005344 scripts/config.py baremetal
5345
5346 # armc[56] don't support SHA-512 intrinsics
5347 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5348
5349 # Stop armclang warning about feature detection for A64_CRYPTO.
5350 # With this enabled, the library does build correctly under armclang,
5351 # but in baremetal builds (as tested here), feature detection is
5352 # unavailable, and the user is notified via a #warning. So enabling
5353 # this feature would prevent us from building with -Werror on
5354 # armclang. Tracked in #7198.
5355 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5356 scripts/config.py set MBEDTLS_HAVE_ASM
5357
Yanray Wang3ae11992023-11-13 17:32:09 +08005358 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005359
5360 # test AESCE baremetal build
5361 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005362 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005363 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005364
Yanray Wangef1b04d2023-09-08 11:09:26 +08005365 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5366 not grep mbedtls_aes_setkey_dec library/aes.o
5367 not grep mbedtls_aria_setkey_dec library/aria.o
5368 not grep mbedtls_camellia_setkey_dec library/camellia.o
5369 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5370 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005371 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005372 not grep mbedtls_aesce_inverse_key library/aesce.o
5373 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005374}
5375
Gilles Peskine592f5912019-10-07 18:49:32 +02005376component_test_ctr_drbg_aes_256_sha_256 () {
5377 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5378 scripts/config.py full
5379 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5380 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005381 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005382 make
5383
5384 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5385 make test
5386}
5387
5388component_test_ctr_drbg_aes_128_sha_512 () {
5389 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005390 scripts/config.py full
5391 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5392 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005393 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005394 make
5395
5396 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5397 make test
5398}
5399
5400component_test_ctr_drbg_aes_128_sha_256 () {
5401 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005402 scripts/config.py full
5403 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5404 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5405 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005406 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005407 make
5408
5409 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5410 make test
5411}
5412
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005413component_test_se_default () {
5414 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005415 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005416 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005417
5418 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5419 make test
5420}
5421
Steven Cooremand57203d2020-07-16 20:28:59 +02005422component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005423 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005424 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005425 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005426 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5427 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005428 loc_cflags="${loc_cflags} -I../tests/include -O2"
5429
Gilles Peskine21570cf2023-12-22 11:49:50 +01005430 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005431
Gilles Peskine1997f302023-07-26 18:45:20 +02005432 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005433 make test
5434}
5435
Gilles Peskine8f073122018-11-27 15:58:47 +01005436component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005437 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005438 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005439 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005440 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005441}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005442
Gilles Peskinecf740502019-07-03 20:43:05 +02005443component_test_cmake_shared () {
5444 msg "build/test: cmake shared" # ~ 2min
5445 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5446 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005447 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005448 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005449 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005450}
5451
Gilles Peskineec10bf12019-09-20 19:56:06 +02005452test_build_opt () {
5453 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005454 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005455 for opt in "$@"; do
5456 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005457 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005458 # We're confident enough in compilers to not run _all_ the tests,
5459 # but at least run the unit tests. In particular, runs with
5460 # optimizations use inline assembly whereas runs with -O0
5461 # skip inline assembly.
5462 make test # ~30s
5463 make clean
5464 done
5465}
5466
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005467# For FreeBSD we invoke the function by name so this condition is added
5468# to disable the existing test_clang_opt function for linux.
5469if [[ $(uname) != "Linux" ]]; then
5470 component_test_clang_opt () {
5471 scripts/config.py full
5472 test_build_opt 'full config' clang -O0 -Os -O2
5473 }
5474fi
5475
5476component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005477 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005478 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005479}
5480support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005481 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005482}
5483
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005484component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005485 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005486 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005487}
5488support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005489 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005490}
5491
5492component_test_gcc_latest_opt () {
5493 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005494 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005495}
5496support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005497 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005498}
5499
5500component_test_gcc_earliest_opt () {
5501 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005502 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005503}
5504support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005505 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005506}
5507
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005508component_build_mbedtls_config_file () {
5509 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005510 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005511 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005512 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005513 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005514 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5515 make clean
5516
5517 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5518 # In the user config, disable one feature (for simplicity, pick a feature
5519 # that nothing else depends on).
5520 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005521 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005522 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5523
5524 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005525}
5526
Gilles Peskine7d904e72022-04-07 21:59:14 +02005527component_build_psa_config_file () {
5528 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5529 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5530 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5531 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5532 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005533 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005534 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5535 make clean
5536
5537 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5538 # In the user config, disable one feature, which will reflect on the
5539 # mbedtls configuration so we can query it with query_compile_time_config.
5540 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5541 scripts/config.py unset MBEDTLS_CMAC_C
5542 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5543 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5544
5545 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005546}
5547
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005548component_build_psa_alt_headers () {
5549 msg "build: make with PSA alt headers" # ~20s
5550
5551 # Generate alternative versions of the substitutable headers with the
5552 # same content except different include guards.
5553 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5554
5555 # Build the library and some programs.
5556 # Don't build the fuzzers to avoid having to go through hoops to set
5557 # a correct include path for programs/fuzz/Makefile.
5558 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
5559 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\"'"
5560
5561 # Check that we're getting the alternative include guards and not the
5562 # original include guards.
5563 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5564 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5565 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5566 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5567}
5568
Dave Rodgman852de3c2023-12-14 14:46:45 +00005569component_test_m32_no_asm () {
5570 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005571 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005572 #
5573 # Note that we require gcc, because clang Asan builds fail to link for
5574 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005575 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005576 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005577 scripts/config.py unset MBEDTLS_HAVE_ASM
5578 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005579 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005580 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005581
Dave Rodgman852de3c2023-12-14 14:46:45 +00005582 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005583 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005584}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005585support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005586 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005587 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005588 *) false;;
5589 esac
5590}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005591
Gilles Peskineff0aee02021-10-05 09:36:03 +02005592component_test_m32_o2 () {
5593 # Build with optimization, to use the i386 specific inline assembly
5594 # and go faster for tests.
5595 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005596 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005597 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005598 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005599
Gilles Peskineff0aee02021-10-05 09:36:03 +02005600 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005601 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005602
Gilles Peskineff0aee02021-10-05 09:36:03 +02005603 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005604 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005605}
Gilles Peskinecf522222021-10-07 19:25:29 +02005606support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005607 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005608}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005609
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005610component_test_m32_everest () {
5611 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005612 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005613 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005614 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005615
5616 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5617 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005618
5619 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005620 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005621
5622 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5623 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005624 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005625}
5626support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005627 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005628}
5629
Gilles Peskine8f073122018-11-27 15:58:47 +01005630component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005631 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005632 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005633 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005634
5635 msg "test: 64-bit ILP32, make, gcc"
5636 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005637}
Gilles Peskine878cf602019-01-06 20:50:38 +00005638support_test_mx32 () {
5639 case $(uname -m) in
5640 amd64|x86_64) true;;
5641 *) false;;
5642 esac
5643}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005644
Peter Kolbus60c6da22018-12-27 06:59:04 -06005645component_test_min_mpi_window_size () {
5646 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005647 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005648 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005649 make
5650
5651 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5652 make test
5653}
5654
Gilles Peskine8f073122018-11-27 15:58:47 +01005655component_test_have_int32 () {
5656 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005657 scripts/config.py unset MBEDTLS_HAVE_ASM
5658 scripts/config.py unset MBEDTLS_AESNI_C
5659 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005660 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005661 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005662
Gilles Peskine8f073122018-11-27 15:58:47 +01005663 msg "test: gcc, force 32-bit bignum limbs"
5664 make test
5665}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005666
Gilles Peskine8f073122018-11-27 15:58:47 +01005667component_test_have_int64 () {
5668 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005669 scripts/config.py unset MBEDTLS_HAVE_ASM
5670 scripts/config.py unset MBEDTLS_AESNI_C
5671 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005672 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005673 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005674
Gilles Peskine8f073122018-11-27 15:58:47 +01005675 msg "test: gcc, force 64-bit bignum limbs"
5676 make test
5677}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005678
Gabor Mezeie256cc12023-07-26 17:28:48 +02005679component_test_have_int32_cmake_new_bignum () {
5680 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5681 scripts/config.py unset MBEDTLS_HAVE_ASM
5682 scripts/config.py unset MBEDTLS_AESNI_C
5683 scripts/config.py unset MBEDTLS_PADLOCK_C
5684 scripts/config.py unset MBEDTLS_AESCE_C
5685 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005686 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005687 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005688
5689 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5690 make test
5691}
5692
Gilles Peskine8f073122018-11-27 15:58:47 +01005693component_test_no_udbl_division () {
5694 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005695 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005696 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005697 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005698
Gilles Peskine8f073122018-11-27 15:58:47 +01005699 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5700 make test
5701}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005702
Gilles Peskine8f073122018-11-27 15:58:47 +01005703component_test_no_64bit_multiplication () {
5704 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005705 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005706 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005707 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005708
Gilles Peskine8f073122018-11-27 15:58:47 +01005709 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5710 make test
5711}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005712
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005713component_test_no_strings () {
5714 msg "build: no strings" # ~10s
5715 scripts/config.py full
5716 # Disable options that activate a large amount of string constants.
5717 scripts/config.py unset MBEDTLS_DEBUG_C
5718 scripts/config.py unset MBEDTLS_ERROR_C
5719 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5720 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005721 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005722
5723 msg "test: no strings" # ~ 10s
5724 make test
5725}
5726
Hanno Beckerc5722d12020-10-09 11:10:42 +01005727component_test_no_x509_info () {
5728 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5729 scripts/config.pl full
5730 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5731 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005732 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005733
5734 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5735 make test
5736
5737 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005738 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005739}
5740
Gilles Peskine8f073122018-11-27 15:58:47 +01005741component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005742 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005743 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005744 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 +02005745
Gilles Peskinee36fe812021-09-01 20:00:33 +02005746 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005747 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005748}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005749
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005750component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005751 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005752 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005753 # Build for a target platform that's close to what Debian uses
5754 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005755 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005756 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005757 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005758 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'
5759
Gilles Peskinee36fe812021-09-01 20:00:33 +02005760 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005761 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005762}
5763support_build_arm_linux_gnueabi_gcc_arm5vte () {
5764 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5765}
5766
5767component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005768 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005769 scripts/config.py baremetal
5770 # This is an imperfect substitute for
5771 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005772 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005773 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 +02005774
Gilles Peskinee36fe812021-09-01 20:00:33 +02005775 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005776 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005777}
5778
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005779component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005780 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5781 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005782 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 +02005783
Gilles Peskinee36fe812021-09-01 20:00:33 +02005784 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005785 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005786 for lib in library/*.a; do
5787 echo "$lib:"
5788 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5789 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005790}
5791
Gilles Peskine8f073122018-11-27 15:58:47 +01005792component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005793 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005794 scripts/config.py baremetal
5795 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005796 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 +01005797 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005798 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005799}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005800
Gilles Peskine8f073122018-11-27 15:58:47 +01005801component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005802 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005803 scripts/config.py baremetal
5804 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005805 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 +01005806 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005807 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005808}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005809
Dave Rodgman8c315f22023-06-02 10:26:24 -04005810component_build_arm_clang_thumb () {
5811 # ~ 30s
5812
5813 scripts/config.py baremetal
5814
5815 msg "build: clang thumb 2, make"
5816 make clean
5817 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5818
5819 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5820 msg "build: clang thumb 1 -O0, make"
5821 make clean
5822 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5823
5824 msg "build: clang thumb 1 -Os, make"
5825 make clean
5826 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5827}
5828
Gilles Peskine8f073122018-11-27 15:58:47 +01005829component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005830 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005831 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005832 # armc[56] don't support SHA-512 intrinsics
5833 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005834
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005835 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5836 scripts/config.py unset MBEDTLS_AESCE_C
5837
Dave Rodgman0fddf822023-03-02 15:32:12 +00005838 # Stop armclang warning about feature detection for A64_CRYPTO.
5839 # With this enabled, the library does build correctly under armclang,
5840 # but in baremetal builds (as tested here), feature detection is
5841 # unavailable, and the user is notified via a #warning. So enabling
5842 # this feature would prevent us from building with -Werror on
5843 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005844 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005845
Hanno Beckerf0762e92022-07-15 12:08:19 +01005846 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005847
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005848 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005849
5850 msg "size: ARM Compiler 5"
5851 "$ARMC5_FROMELF" -z library/*.o
5852
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005853 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005854
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005855 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005856 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005857
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005858 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005859 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5860
5861 # ARM Compiler 6 - Target ARMv7-M+DSP
5862 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005863
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005864 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005865 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005866
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005867 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005868 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005869
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005870 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5871 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5872
Dave Rodgman99318e62023-05-24 12:27:42 +01005873 # ARM Compiler 6 - Target Cortex-M0
5874 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005875
5876 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5877 #
5878 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5879 # that we have in our CI
5880 scripts/config.py set MBEDTLS_AESCE_C
5881 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005882}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005883
Pengyu Lvdf070032023-02-24 16:03:31 +08005884support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005885 armc5_cc="$ARMC5_BIN_DIR/armcc"
5886 armc6_cc="$ARMC6_BIN_DIR/armclang"
5887 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005888}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005889
Ronald Crond2cb7f42024-03-18 12:49:18 +01005890component_test_tls12_only () {
5891 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5892 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5893 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5894 make
5895
5896 msg "test: main suites (inc. selftests) (ASan build)"
5897 make test
5898
5899 msg "test: ssl-opt.sh (ASan build)"
5900 tests/ssl-opt.sh
5901
5902 msg "test: compat.sh (ASan build)"
5903 tests/compat.sh
5904}
5905
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005906component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005907 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005908 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005909 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005910 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5911
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005912 msg "test: TLS 1.3 only, all key exchange modes enabled"
5913 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005914
Ronald Cronc3f43b62022-10-17 17:35:32 +02005915 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5916 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005917}
5918
Ronald Cronc3f43b62022-10-17 17:35:32 +02005919component_test_tls13_only_psk () {
5920 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5921 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5922 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5923 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005924 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005925 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5926 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5927 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5928 scripts/config.py unset MBEDTLS_ECDSA_C
5929 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005930 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005931 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005932 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5933
Ronald Cronc3f43b62022-10-17 17:35:32 +02005934 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5935 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005936
Ronald Cronc3f43b62022-10-17 17:35:32 +02005937 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5938 tests/ssl-opt.sh
5939}
5940
5941component_test_tls13_only_ephemeral () {
5942 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5943 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5944 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005945 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005946 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5947
5948 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5949 cd tests; ./test_suite_ssl; cd ..
5950
5951 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5952 tests/ssl-opt.sh
5953}
5954
Przemek Stekiela01c2422023-06-13 10:46:48 +02005955component_test_tls13_only_ephemeral_ffdh () {
5956 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5957 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5958 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5959 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005960 scripts/config.py unset MBEDTLS_ECDH_C
5961
Przemek Stekiela01c2422023-06-13 10:46:48 +02005962 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5963
5964 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5965 cd tests; ./test_suite_ssl; cd ..
5966
5967 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5968 tests/ssl-opt.sh
5969}
5970
Ronald Cronc3f43b62022-10-17 17:35:32 +02005971component_test_tls13_only_psk_ephemeral () {
5972 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5973 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5974 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5975 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5976 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5977 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5978 scripts/config.py unset MBEDTLS_ECDSA_C
5979 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005980 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005981 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005982 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5983
5984 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5985 cd tests; ./test_suite_ssl; cd ..
5986
5987 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5988 tests/ssl-opt.sh
5989}
5990
Przemek Stekiela01c2422023-06-13 10:46:48 +02005991component_test_tls13_only_psk_ephemeral_ffdh () {
5992 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5993 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5994 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5995 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5996 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5997 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5998 scripts/config.py unset MBEDTLS_ECDSA_C
5999 scripts/config.py unset MBEDTLS_PKCS1_V21
6000 scripts/config.py unset MBEDTLS_PKCS7_C
6001 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02006002 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02006003 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6004
6005 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6006 cd tests; ./test_suite_ssl; cd ..
6007
6008 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6009 tests/ssl-opt.sh
6010}
6011
Ronald Cronc3f43b62022-10-17 17:35:32 +02006012component_test_tls13_only_psk_all () {
6013 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
6014 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6015 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6016 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6017 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6018 scripts/config.py unset MBEDTLS_ECDSA_C
6019 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00006020 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01006021 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006022 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6023
6024 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6025 cd tests; ./test_suite_ssl; cd ..
6026
6027 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6028 tests/ssl-opt.sh
6029}
6030
6031component_test_tls13_only_ephemeral_all () {
6032 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
6033 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01006034 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006035 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6036
6037 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6038 cd tests; ./test_suite_ssl; cd ..
6039
6040 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6041 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02006042}
6043
Ronald Cron46ac0652024-03-18 12:39:04 +01006044component_test_tls13_no_padding () {
6045 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006046 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01006047 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006048 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006049 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006050 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006051 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01006052 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006053 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006054}
6055
Ronald Cron6f135e12021-12-08 16:57:54 +01006056component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01006057 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006058 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01006059 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006060 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01006061 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006062 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006063 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01006064 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006065 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006066}
6067
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006068component_test_full_minus_session_tickets() {
6069 msg "build: full config without session tickets"
6070 scripts/config.py full
Norbert Fabritius06d99342023-04-11 15:40:05 +02006071 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006072 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritius06d99342023-04-11 15:40:05 +02006073 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
6074 make
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006075 msg "test: full config without session tickets"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006076 make test
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006077 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006078 tests/ssl-opt.sh
6079}
6080
Gilles Peskine8f073122018-11-27 15:58:47 +01006081component_build_mingw () {
6082 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006083 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 +00006084
Gilles Peskine8f073122018-11-27 15:58:47 +01006085 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006086 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 +01006087 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02006088
Gilles Peskine8f073122018-11-27 15:58:47 +01006089 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006090 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 SHARED=1 lib programs
6091 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 +01006092 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006093
Pengyu Lv158eead2023-10-19 11:27:05 +08006094 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006095 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08006096 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 +01006097 make WINDOWS_BUILD=1 clean
6098}
Jaeden Amero117b8a42019-04-17 15:19:26 +01006099support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08006100 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
6101 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01006102 *) true;;
6103 esac
6104}
Simon Butcher91aef332016-11-17 09:20:50 +00006105
Gilles Peskine8f073122018-11-27 15:58:47 +01006106component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006107 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02006108 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006109 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6110 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006111
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006112 msg "test: main suites (MSan)" # ~ 10s
6113 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006114
Gilles Peskine6848d172023-11-02 19:58:03 +01006115 msg "test: metatests (MSan)"
6116 tests/scripts/run-metatests.sh any msan
6117
Gilles Peskine82b27272019-06-14 18:27:03 +02006118 msg "program demos (MSan)" # ~20s
6119 tests/scripts/run_demos.py
6120
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006121 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006122 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006123
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006124 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006125
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006126 if [ "$MEMORY" -gt 0 ]; then
6127 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006128 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006129 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006130}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006131
Bence Szépkúti0354d042023-12-06 16:14:37 +01006132component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006133 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006134 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006135 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6136 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006137
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006138 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006139 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006140
Gilles Peskine636c26a2020-03-04 20:46:15 +01006141 # Optional parts (slow; currently broken on OS X because programs don't
6142 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006143 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006144 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006145 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006146 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006147 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006148
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006149 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006150 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006151 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006152 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006153
6154 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006155 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006156 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006157 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006158}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006159
Bence Szépkúti0354d042023-12-06 16:14:37 +01006160component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006161 msg "build: Release, full (clang)"
6162 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6163 scripts/config.py full
6164 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6165 make
6166
6167 msg "test: main suites, Valgrind (full config)"
6168 make memcheck
6169}
6170
Paul Elliott62dc3922021-11-25 17:29:40 +00006171support_test_cmake_out_of_source () {
6172 distrib_id=""
6173 distrib_ver=""
6174 distrib_ver_minor=""
6175 distrib_ver_major=""
6176
6177 # Attempt to parse lsb-release to find out distribution and version. If not
6178 # found this should fail safe (test is supported).
6179 if [[ -f /etc/lsb-release ]]; then
6180
6181 while read -r lsb_line; do
6182 case "$lsb_line" in
6183 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6184 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6185 esac
6186 done < /etc/lsb-release
6187
6188 distrib_ver_major="${distrib_ver%%.*}"
6189 distrib_ver="${distrib_ver#*.}"
6190 distrib_ver_minor="${distrib_ver%%.*}"
6191 fi
6192
6193 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6194 # processor (as the CI does) can create a race condition whereby the build
6195 # fails to see a generated file, despite that file actually having been
6196 # generated. This problem appears to go away with 18.04 or newer, so make
6197 # the out of source tests unsupported on Ubuntu 16.04.
6198 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6199}
6200
Gilles Peskine8f073122018-11-27 15:58:47 +01006201component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006202 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006203 # generates
6204 make neat
6205
Gilles Peskine8f073122018-11-27 15:58:47 +01006206 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006207 MBEDTLS_ROOT_DIR="$PWD"
6208 mkdir "$OUT_OF_SOURCE_DIR"
6209 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006210 # Note: Explicitly generate files as these are turned off in releases
6211 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006212 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006213
Gilles Peskine8f073122018-11-27 15:58:47 +01006214 msg "test: cmake 'out-of-source' build"
6215 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006216 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006217 # Also ensure that there are no error messages such as
6218 # "No such file or directory", which would indicate that some required
6219 # file is missing (ssl-opt.sh tolerates the absence of some files so
6220 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006221 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006222 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006223 cat ssl-opt.err >&2
6224 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006225 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006226 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006227 cd "$MBEDTLS_ROOT_DIR"
6228 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006229}
Andres AGdc192212016-08-31 17:33:13 +01006230
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006231component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006232 # Remove existing generated files so that we use the ones CMake
6233 # generates
6234 make neat
6235
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006236 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006237 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006238 # Note: Explicitly generate files as these are turned off in releases
6239 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006240 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006241 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006242}
Gilles Peskinea3000992022-02-04 00:21:12 +01006243support_test_cmake_as_subdirectory () {
6244 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006245}
6246
Chris Kayd259e342021-03-25 16:03:25 +00006247component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006248 # Remove existing generated files so that we use the ones CMake
6249 # generates
6250 make neat
6251
Chris Kayd259e342021-03-25 16:03:25 +00006252 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006253 cd programs/test/cmake_package
6254 cmake .
6255 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006256 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006257}
Gilles Peskinea3000992022-02-04 00:21:12 +01006258support_test_cmake_as_package () {
6259 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006260}
6261
6262component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006263 # Remove existing generated files so that we use the ones CMake
6264 # generates
6265 make neat
6266
Chris Kayd259e342021-03-25 16:03:25 +00006267 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006268 cd programs/test/cmake_package_install
6269 cmake .
6270 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006271 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006272}
Gilles Peskinea3000992022-02-04 00:21:12 +01006273support_test_cmake_as_package_install () {
6274 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006275}
6276
David Horstmann20550e32023-01-12 14:17:01 +00006277component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006278 # Make a copy of config file to use for the in-tree test
6279 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006280
6281 MBEDTLS_ROOT_DIR="$PWD"
6282 mkdir "$OUT_OF_SOURCE_DIR"
6283 cd "$OUT_OF_SOURCE_DIR"
6284
David Horstmann969c1452023-01-31 10:34:44 +00006285 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006286 cmake "$MBEDTLS_ROOT_DIR"
6287 make
6288
6289 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6290 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006291 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006292 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6293 make
6294
6295 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6296 # In the user config, disable one feature (for simplicity, pick a feature
6297 # that nothing else depends on).
6298 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6299
6300 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6301 make
6302 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6303
6304 rm -f user_config.h full_config.h
6305
6306 cd "$MBEDTLS_ROOT_DIR"
6307 rm -rf "$OUT_OF_SOURCE_DIR"
6308
6309 # Now repeat the test for an in-tree build:
6310
David Horstmann969c1452023-01-31 10:34:44 +00006311 # Restore config for the in-tree test
6312 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006313
David Horstmann969c1452023-01-31 10:34:44 +00006314 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006315 cmake .
6316 make
6317
6318 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6319 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006320 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006321 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6322 make
6323
6324 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6325 # In the user config, disable one feature (for simplicity, pick a feature
6326 # that nothing else depends on).
6327 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6328
6329 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6330 make
6331 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6332
6333 rm -f user_config.h full_config.h
6334}
6335support_build_cmake_custom_config_file () {
6336 support_test_cmake_out_of_source
6337}
6338
6339
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006340component_build_zeroize_checks () {
6341 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6342
6343 scripts/config.py full
6344
6345 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006346 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 +01006347}
6348
6349
Gilles Peskine8f073122018-11-27 15:58:47 +01006350component_test_zeroize () {
6351 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6352 # different combinations of compilers and optimization flags by using an
6353 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6354 # system in all cases that the script fails, so we must manually search the
6355 # output to check whether the pass string is present and no failure strings
6356 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006357
Gilles Peskine4976e822019-01-06 19:52:22 +00006358 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6359 # about a spurious message if Gdb tries and fails, so suppress that.
6360 gdb_disable_aslr=
6361 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6362 gdb_disable_aslr='set disable-randomization off'
6363 fi
6364
Gilles Peskine8f073122018-11-27 15:58:47 +01006365 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006366 for compiler in clang gcc; do
6367 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6368 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006369 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6370 grep "The buffer was correctly zeroized" test_zeroize.log
6371 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006372 rm -f test_zeroize.log
6373 make clean
6374 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006375 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006376}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006377
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006378component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006379 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006380 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006381 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006382
6383 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006384 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006385}
6386
6387support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006388 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006389 ver="$(cmake --version)"
6390 ver="${ver#cmake version }"
6391 ver_major="${ver%%.*}"
6392
6393 ver="${ver#*.}"
6394 ver_minor="${ver%%.*}"
6395
6396 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006397}
6398
Gilles Peskinec848d222022-12-09 12:23:35 +01006399component_check_code_style () {
6400 msg "Check C code style"
6401 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006402}
6403
Gilles Peskinec848d222022-12-09 12:23:35 +01006404support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006405 case $(uncrustify --version) in
6406 *0.75.1*) true;;
6407 *) false;;
6408 esac
6409}
6410
Gilles Peskine8f073122018-11-27 15:58:47 +01006411component_check_python_files () {
6412 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006413 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006414}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006415
Joe Subbianid614c0b2021-07-29 11:18:29 +01006416component_check_test_helpers () {
6417 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006418 # unittest writes out mundane stuff like number or tests run on stderr.
6419 # Our convention is to reserve stderr for actual errors, and write
6420 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006421 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006422
Joe Subbiania25ffab2021-08-06 09:41:27 +01006423 msg "unit test: translate_ciphers.py"
6424 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006425}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006426
Jerry Yud767cc42023-03-31 15:03:55 +08006427
Gilles Peskine192c72f2017-12-21 15:59:21 +01006428################################################################
6429#### Termination
6430################################################################
6431
Gilles Peskine8f073122018-11-27 15:58:47 +01006432post_report () {
6433 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006434 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006435
Gilles Peskine8f073122018-11-27 15:58:47 +01006436 final_report
6437}
6438
6439
6440
6441################################################################
6442#### Run all the things
6443################################################################
6444
Gilles Peskine5d996822020-03-28 21:09:21 +01006445# Function invoked by --error-test to test error reporting.
6446pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006447 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006448 if [ $KEEP_GOING -ne 0 ]; then
6449 echo "Expect three failing commands."
6450 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006451 # If the component doesn't run in a subshell, changing error_test_i to an
6452 # invalid integer will cause an error in the loop that runs this function.
6453 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006454 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006455 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006456 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006457 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006458 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006459 make unknown_target
6460 false "this should not be executed"
6461}
6462
Gilles Peskinee48351a2018-11-27 16:06:30 +01006463# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006464run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006465 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006466 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006467
6468 # Unconditionally create a seedfile that's sufficiently long.
6469 # Do this before each component, because a previous component may
6470 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006471 local dd_cmd
6472 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6473 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006474 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006475 esac
6476 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006477
Gilles Peskineec135542021-08-02 23:14:03 +02006478 # Run the component in a subshell, with error trapping and output
6479 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006480 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006481 # We want to keep running if the subshell fails, so 'set -e' must
6482 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006483 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006484 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006485 (
6486 if [ $QUIET -eq 1 ]; then
6487 # msg() will be silenced, so just print the component name here.
6488 echo "${current_component#component_}"
6489 exec >/dev/null
6490 fi
6491 if [ $KEEP_GOING -eq 1 ]; then
6492 # Keep "set -e" off, and run an ERR trap instead to record failures.
6493 set -E
6494 trap err_trap ERR
6495 fi
6496 # The next line is what runs the component
6497 "$@"
6498 if [ $KEEP_GOING -eq 1 ]; then
6499 trap - ERR
6500 exit $last_failure_status
6501 fi
6502 )
6503 component_status=$?
6504 if [ $KEEP_GOING -eq 1 ]; then
6505 set -e
6506 if [ $component_status -ne 0 ]; then
6507 failure_count=$((failure_count + 1))
6508 fi
6509 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006510
6511 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006512 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006513 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006514}
6515
6516# Preliminary setup
6517pre_check_environment
6518pre_initialize_variables
6519pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006520
Dave Rodgman21900632024-02-26 11:41:19 +00006521setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006522pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006523pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006524pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006525
Gilles Peskine878cf602019-01-06 20:50:38 +00006526build_status=0
6527if [ $KEEP_GOING -eq 1 ]; then
6528 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006529fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006530pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006531pre_print_configuration
6532pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006533cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006534if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006535 pre_generate_files
6536fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006537
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006538# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006539for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006540 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006541done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006542unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006543for component in $RUN_COMPONENTS; do
6544 run_component "component_$component"
6545done
Gilles Peskine8f073122018-11-27 15:58:47 +01006546
6547# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006548post_report