blob: e101bb657badd636c709975307ed3e90496a5d64 [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)
47# * OPENSSL_NEXT = 1.1.1a
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
Gilles Peskine396853a2021-09-20 18:57:55 +0200198 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000199 export CTEST_OUTPUT_ON_FAILURE=1
200
Gilles Peskine8fd59422019-10-21 17:11:33 +0200201 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100202 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200203 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000204 # Normally, tests should use this compiler for ASAN testing
205 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200206
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400207 # Platform tests have an allocation that returns null
208 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400209 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400210
Gilles Peskine878cf602019-01-06 20:50:38 +0000211 # Gather the list of available components. These are the functions
212 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100213 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000214
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000215 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100216 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100217}
Andres AG38495a32016-07-12 16:54:33 +0100218
Dave Rodgman21900632024-02-26 11:41:19 +0000219setup_quiet_wrappers()
220{
221 # Pick up "quiet" wrappers for make and cmake, which don't output very much
222 # unless there is an error. This reduces logging overhead in the CI.
223 #
224 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000225 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
226 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000227 fi
228}
229
Gilles Peskinea28db922019-01-10 00:05:18 +0100230# Test whether the component $1 is included in the command line patterns.
231is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100232{
Gilles Peskine03af6782021-08-06 11:35:17 +0200233 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
234 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100235 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000236 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100237 set +f
238 case ${1#component_} in $pattern) return 0;; esac
239 done
240 set +f
241 return 1
242}
Andres AG7770ea82016-10-10 15:46:20 +0100243
Simon Butcher41eeccf2016-09-07 00:07:09 +0100244usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100245{
Gilles Peskine709346a2017-12-10 23:43:39 +0100246 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100247Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100248Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100249By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100250COMPONENT can be the name of a component or a shell wildcard pattern.
251
252Examples:
253 $0 "check_*"
254 Run all sanity checks.
255 $0 --no-armcc --except test_memsan
256 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100257
258Special options:
259 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000260 --list-all-components List all available test components and exit.
261 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100262
263General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200264 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100265 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100266 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100267 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200268 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200269 --arm-none-eabi-gcc-prefix=<string>
270 Prefix for a cross-compiler for arm-none-eabi
271 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200272 --arm-linux-gnueabi-gcc-prefix=<string>
273 Prefix for a cross-compiler for arm-linux-gnueabi
274 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100275 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200276 --restore First clean up the build tree, restoring backed up
277 files. Do not run any components unless they are
278 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100279 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200280 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100281 --except Exclude the COMPONENTs listed on the command line,
282 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200283 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100284 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100285 --no-force Refuse to overwrite modified files (default).
286 --no-keep-going Stop at the first error (default).
287 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800288 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100289 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200290 --outcome-file=<path> File where test outcomes are written (not done if
291 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100292 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200293 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100294 -s|--seed Integer seed value to use for this test run.
295
296Tool path options:
297 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
298 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100299 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
300 --clang-latest=<Clang_latest_path> Latest version of clang available
301 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
302 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100303 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
304 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100305 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100306 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100307EOF
SimonB2e23c822016-04-16 21:54:39 +0100308}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100309
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200310# Cleanup before/after running a component.
311# Remove built files as well as the cmake cache/config.
312# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313cleanup()
314{
David Horstmann76a77382023-08-17 17:32:26 +0100315 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100316 command make clean
317 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200318
Gilles Peskine31b07e22018-03-21 12:15:06 +0100319 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000320 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100321 -iname CMakeFiles -exec rm -rf {} \+ -o \
322 \( -iname cmake_install.cmake -o \
323 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200324 -iname CMakeCache.txt -o \
325 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100326 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200327 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200328
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100329 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
330 rm -rf programs/test/cmake_subproject/build
331 rm -f programs/test/cmake_subproject/Makefile
332 rm -f programs/test/cmake_subproject/cmake_subproject
333
Chris Kayd259e342021-03-25 16:03:25 +0000334 # Remove any artifacts from the component_test_cmake_as_package test.
335 rm -rf programs/test/cmake_package/build
336 rm -f programs/test/cmake_package/Makefile
337 rm -f programs/test/cmake_package/cmake_package
338
339 # Remove any artifacts from the component_test_cmake_as_installed_package test.
340 rm -rf programs/test/cmake_package_install/build
341 rm -f programs/test/cmake_package_install/Makefile
342 rm -f programs/test/cmake_package_install/cmake_package_install
343
Gilles Peskinef83eb822020-03-30 20:11:39 +0200344 # Restore files that may have been clobbered by the job
345 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200346 if [[ -e "$x$backup_suffix" ]]; then
347 cp -p "$x$backup_suffix" "$x"
348 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200349 done
350}
John Durkopbd069d32020-10-31 22:14:03 -0700351
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200352# Final cleanup when this script exits (except when exiting on a failure
353# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200354final_cleanup () {
355 cleanup
356
357 for x in $files_to_back_up; do
358 rm -f "$x$backup_suffix"
359 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100360}
361
Gilles Peskine7c652162017-12-11 00:01:40 +0100362# Executed on exit. May be redefined depending on command line options.
363final_report () {
364 :
365}
366
367fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200368 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100369 final_report $1
370 trap - $1
371 kill -$1 $$
372}
373
374trap 'fatal_signal HUP' HUP
375trap 'fatal_signal INT' INT
376trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200377
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200378# Number of processors on this machine. Used as the default setting
379# for parallel make.
380all_sh_nproc ()
381{
382 {
383 nproc || # Linux
384 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
385 sysctl -n hw.ncpu || # FreeBSD
386 echo 1
387 } 2>/dev/null
388}
389
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100390msg()
391{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100392 if [ -n "${current_component:-}" ]; then
393 current_section="${current_component#component_}: $1"
394 else
395 current_section="$1"
396 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200397
398 if [ $QUIET -eq 1 ]; then
399 return
400 fi
401
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100402 echo ""
403 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100404 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000405 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo "******************************************************************"
407}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100408
Gilles Peskine8f073122018-11-27 15:58:47 +0100409armc6_build_test()
410{
411 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100412
Gilles Peskine18487f62020-04-30 23:11:54 +0200413 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800414 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100415 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000416 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200417
418 msg "size: ARM Compiler 6 ($FLAGS)"
419 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100420}
Andres AGa5cd9732016-10-17 15:23:10 +0100421
Andres AGd9eba4b2016-08-26 14:42:14 +0100422err_msg()
423{
424 echo "$1" >&2
425}
426
427check_tools()
428{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200429 for tool in "$@"; do
430 if ! `type "$tool" >/dev/null 2>&1`; then
431 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100432 exit 1
433 fi
434 done
435}
436
Gilles Peskine8f073122018-11-27 15:58:47 +0100437pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000438 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100439 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100440 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100441 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200442 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000443 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100444
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000445 # Note that legacy options are ignored instead of being omitted from this
446 # list of options, so invocations that worked with previous version of
447 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100448 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100449 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200450 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200451 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200452 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000453 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100454 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
455 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100456 --clang-earliest) shift; CLANG_EARLIEST="$1";;
457 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100458 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000459 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100460 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100461 --gcc-earliest) shift; GCC_EARLIEST="$1";;
462 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100463 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200464 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
465 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100466 --gnutls-serv) shift; GNUTLS_SERV="$1";;
467 --help|-h) usage; exit;;
468 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000469 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100470 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100471 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200472 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000473 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100474 --no-force) FORCE=0;;
475 --no-keep-going) KEEP_GOING=0;;
476 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200477 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100479 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200480 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200482 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200484 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200485 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --seed|-s) shift; SEED="$1";;
487 -*)
488 echo >&2 "Unknown option: $1"
489 echo >&2 "Run $0 --help for usage."
490 exit 120
491 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000492 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 esac
494 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100495 done
SimonB2e23c822016-04-16 21:54:39 +0100496
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100497 # Exclude components that are not supported on this platform.
498 SUPPORTED_COMPONENTS=
499 for component in $ALL_COMPONENTS; do
500 case $(type "support_$component" 2>&1) in
501 *' function'*)
502 if ! support_$component; then continue; fi;;
503 esac
504 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
505 done
506
507 if [ $list_components -eq 1 ]; then
508 printf '%s\n' $SUPPORTED_COMPONENTS
509 exit
510 fi
511
Gilles Peskinea28db922019-01-10 00:05:18 +0100512 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200513 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000514 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100515 fi
516
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000517 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
518 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100519 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000520 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100521 fi
SimonB2e23c822016-04-16 21:54:39 +0100522
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200523 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100524 if [ $all_except -eq 0 ]; then
525 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200526 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
527 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200528 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100529 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200530 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200531 # If the requested name includes a wildcard character, don't
532 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 case $component in
534 *[*?\[]*) continue;;
535 esac
536 case " $SUPPORTED_COMPONENTS " in
537 *" $component "*) :;;
538 *)
539 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
540 unsupported=$((unsupported + 1));;
541 esac
542 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200543 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100544 if [ $unsupported -ne 0 ]; then
545 exit 2
546 fi
547 fi
548
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000549 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100550 RUN_COMPONENTS=
551 for component in $SUPPORTED_COMPONENTS; do
552 if is_component_included "$component"; [ $? -eq $all_except ]; then
553 RUN_COMPONENTS="$RUN_COMPONENTS $component"
554 fi
555 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000556
557 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000558 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100559}
SimonB2e23c822016-04-16 21:54:39 +0100560
Gilles Peskine8f073122018-11-27 15:58:47 +0100561pre_check_git () {
562 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100563 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100564 git checkout-index -f -q $CONFIG_H
565 cleanup
566 else
SimonB2e23c822016-04-16 21:54:39 +0100567
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
569 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
570 echo "You can either delete this directory manually, or force the test by rerunning"
571 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
572 exit 1
573 fi
574
Ronald Cron7a93ac52023-07-20 09:49:12 +0200575 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100576 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100577 echo "You can either delete or preserve your work, or force the test by rerunning the"
578 echo "script as: $0 --force"
579 exit 1
580 fi
SimonB2e23c822016-04-16 21:54:39 +0100581 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500582}
583
Gilles Peskine568f53a2021-07-12 18:16:01 +0200584pre_restore_files () {
585 # If the makefiles have been generated by a framework such as cmake,
586 # restore them from git. If the makefiles look like modifications from
587 # the ones checked into git, take care not to modify them. Whatever
588 # this function leaves behind is what the script will restore before
589 # each component.
590 case "$(head -n1 Makefile)" in
591 *[Gg]enerated*)
592 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
593 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
594 ;;
595 esac
596}
597
Gilles Peskinef83eb822020-03-30 20:11:39 +0200598pre_back_up () {
599 for x in $files_to_back_up; do
600 cp -p "$x" "$x$backup_suffix"
601 done
602}
603
Gilles Peskine8f073122018-11-27 15:58:47 +0100604pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100605 failure_count=0 # Number of failed components
606 last_failure_status=0 # Last failure status in this component
607
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100608 # See err_trap
609 previous_failure_status=0
610 previous_failed_command=
611 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100612 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100613
Gilles Peskine7c652162017-12-11 00:01:40 +0100614 start_red=
615 end_color=
616 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100617 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
619 start_red=$(printf '\033[31m')
620 end_color=$(printf '\033[0m')
621 ;;
622 esac
623 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100624
625 # Keep a summary of failures in a file. We'll print it out at the end.
626 failure_summary_file=$PWD/all-sh-failures-$$.log
627 : >"$failure_summary_file"
628
629 # Whether it makes sense to keep a component going after the specified
630 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200631 # This function normally receives the failing simple command
632 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
633 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100634 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200635 # False positives result in running things that can't be expected to
636 # work. False negatives result in things not running after something else
637 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 can_keep_going_after_failure () {
639 case "$1" in
640 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200641 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100642 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200643 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
644 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
645 *make*check*) true;;
646 "grep "*) true;;
647 "[ "*) true;;
648 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100649 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100650 esac
651 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100652
653 # This function runs if there is any error in a component.
654 # It must either exit with a nonzero status, or set
655 # last_failure_status to a nonzero value.
656 err_trap () {
657 # Save $? (status of the failing command). This must be the very
658 # first thing, before $? is overridden.
659 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100660 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100661
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100662 if [[ $last_failure_status -eq $previous_failure_status &&
663 "$failed_command" == "$previous_failed_command" &&
664 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
665 then
666 # The same command failed twice in a row, but this time one level
667 # less deep in the function call stack. This happens when the last
668 # command of a function returns a nonzero status, and the function
669 # returns that same status. Ignore the second failure.
670 previous_failure_funcall_depth=${#FUNCNAME[@]}
671 return
672 fi
673 previous_failure_status=$last_failure_status
674 previous_failed_command=$failed_command
675 previous_failure_funcall_depth=${#FUNCNAME[@]}
676
Gilles Peskinece266c42020-03-28 18:50:43 +0100677 text="$current_section: $failed_command -> $last_failure_status"
678 echo "${start_red}^^^^$text^^^^${end_color}" >&2
679 echo "$text" >>"$failure_summary_file"
680
681 # If the command is fatal (configure or build command), stop this
682 # component. Otherwise (test command) keep the component running
683 # (run more tests from the same build).
684 if ! can_keep_going_after_failure "$failed_command"; then
685 exit $last_failure_status
686 fi
687 }
688
Gilles Peskine7c652162017-12-11 00:01:40 +0100689 final_report () {
690 if [ $failure_count -gt 0 ]; then
691 echo
692 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100693 echo "${start_red}FAILED: $failure_count components${end_color}"
694 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100695 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
696 elif [ -z "${1-}" ]; then
697 echo "SUCCESS :)"
698 fi
699 if [ -n "${1-}" ]; then
700 echo "Killed by SIG$1."
701 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100702 rm -f "$failure_summary_file"
703 if [ $failure_count -gt 0 ]; then
704 exit 1
705 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100706 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100707}
708
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200709# record_status() and if_build_succeeded() are kept temporarily for backward
710# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100711record_status () {
712 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100713}
Gilles Peskine7c652162017-12-11 00:01:40 +0100714if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100715 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100716}
717
Gilles Peskinea681c592020-03-28 21:27:40 +0100718# '! true' does not trigger the ERR trap. Arrange to trigger it, with
719# a reasonably informative error message (not just "$@").
720not () {
721 if "$@"; then
722 report_failed_command="! $*"
723 false
724 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200725 fi
726}
727
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200728pre_prepare_outcome_file () {
729 case "$MBEDTLS_TEST_OUTCOME_FILE" in
730 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
731 esac
732 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
733 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
734 fi
735}
736
Gilles Peskine8f073122018-11-27 15:58:47 +0100737pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200738 if [ $QUIET -eq 1 ]; then
739 return
740 fi
741
Gilles Peskine8f073122018-11-27 15:58:47 +0100742 msg "info: $0 configuration"
743 echo "MEMORY: $MEMORY"
744 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200745 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100747 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100748 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100749 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
750 echo "GNUTLS_CLI: $GNUTLS_CLI"
751 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
753 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
754}
Andres AG7770ea82016-10-10 15:46:20 +0100755
Andres AGd9eba4b2016-08-26 14:42:14 +0100756# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100757pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000758 # Build the list of variables to pass to output_env.sh.
759 set env
SimonB2e23c822016-04-16 21:54:39 +0100760
Gilles Peskine87964262019-01-06 22:40:00 +0000761 case " $RUN_COMPONENTS " in
762 # Require OpenSSL and GnuTLS if running any tests (as opposed to
763 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
764 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100765 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000766 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
767 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100768 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000769 export GNUTLS_CLI="$GNUTLS_CLI"
770 export GNUTLS_SERV="$GNUTLS_SERV"
771 # Avoid passing --seed flag in every call to ssl-opt.sh
772 if [ -n "${SEED-}" ]; then
773 export SEED
774 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200775 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000776 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200777 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
778 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000779 ;;
780 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200781
Gilles Peskine87964262019-01-06 22:40:00 +0000782 case " $RUN_COMPONENTS " in
783 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
784 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200787 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
791 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
792 esac
793
794 case " $RUN_COMPONENTS " in
795 *" test_zeroize "*) check_tools "gdb";;
796 esac
797
798 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000799 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000800 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
801 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200802 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000803 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
804 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200805 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
806 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
807 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000808 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000809
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200810 # past this point, no call to check_tool, only printing output
811 if [ $QUIET -eq 1 ]; then
812 return
813 fi
814
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000815 msg "info: output_env.sh"
816 case $RUN_COMPONENTS in
817 *_armcc*)
818 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
819 *) set "$@" RUN_ARMCC=0;;
820 esac
821 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100822}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100823
Gilles Peskine1570b592021-04-22 01:10:12 +0200824pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200825 # since make doesn't have proper dependencies, remove any possibly outdate
826 # file that might be around before generating fresh ones
827 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200828 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200829 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200830 else
831 make generated_files
832 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200833}
834
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000835clang_version() {
836 if command -v clang > /dev/null ; then
837 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
838 else
839 echo 0 # report version 0 for "no clang"
840 fi
841}
842
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200843################################################################
844#### Helpers for components using libtestdriver1
845################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100846
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200847# How to use libtestdriver1
848# -------------------------
849#
850# 1. Define the list algorithms and key types to accelerate,
851# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
852# Examples:
853# - loc_accel_list="ALG_JPAKE"
854# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200855# 2. Make configurations changes for the driver and/or main libraries.
856# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
857# can be either "default" to start with the default config, or a name
858# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200859# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200860# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
861# These changes affect both the driver and the main libraries.
862# (Note: they need to have the same set of PSA_WANT symbols, as that
863# determines the ABI between them.)
864# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
865# main libraries. Typically, you want to disable the module(s) that are
866# being accelerated. You may need to also disable modules that depend
867# on them or options that are not supported with drivers.
868# 2d. On top of psa/crypto_config.h, the driver library uses its own config
869# file: tests/include/test/drivers/config_test_driver.h. You usually
870# don't need to edit it: using loc_extra_list (see below) is preferred.
871# However, when there's no PSA symbol for what you want to enable,
872# calling scripts/config.py on this file remains the only option.
873# 3. Build the driver library, then the main libraries, test, and programs.
874# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
875# need to enable more algorithms here, typically hash algorithms when
876# accelerating some signature algorithms (ECDSA, RSAv2). This is done
877# by passing a 2nd argument listing the extra algorithms.
878# Example:
879# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
880# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800881# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200882# additional arguments will be passed to make: this can be useful if
883# you don't want to build everything when iterating during development.
884# Example:
885# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
886# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200887
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200888# Adjust the configuration - for both libtestdriver1 and main library,
889# as they should have the same PSA_WANT macros.
890helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200891 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200892 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200893 if [ "$base_config" != "default" ]; then
894 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200895 fi
896
897 # Enable PSA-based config (necessary to use drivers)
898 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
899
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200900 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
901 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
902 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000903
904 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
905 # otherwise we will end up running multithreaded tests without mutexes to protect them.
906 if scripts/config.py get MBEDTLS_THREADING_C; then
907 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
908 fi
909
910 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
912 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200913}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100914
Valerio Settib2fd6732023-08-15 17:10:47 +0200915# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200916# The function optionally accepts 1 parameter: a space-separated list of the
917# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200918helper_disable_builtin_curves() {
919 allowed_list="${1:-}"
920 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
921
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200922 for curve in $allowed_list; do
923 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200924 done
925}
926
927# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
928# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
929# in the following helpers.
930helper_get_psa_curve_list () {
931 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200932 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
933 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200934 done
935
936 echo "$loc_list"
937}
938
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100939# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
940# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
941# in the following helpers.
942helper_get_psa_dh_group_list () {
943 loc_list=""
944 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
945 loc_list="$loc_list $item"
946 done
947
948 echo "$loc_list"
949}
950
Valerio Settib2fd6732023-08-15 17:10:47 +0200951# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200952# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200953# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200954helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200955 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200956 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200957 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 +0200958 # Skip DERIVE for elliptic keys since there is no driver dispatch for
959 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200960 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
961 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200962 fi
963 done
964
965 echo "$loc_list"
966}
967
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200968# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200969#
970# Parameters:
971# 1. a space-separated list of things to accelerate;
972# 2. optional: a space-separate list of things to also support.
973# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
974helper_libtestdriver1_make_drivers() {
975 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100976 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 +0200977}
978
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200979# Build the main libraries, programs and tests,
980# linking to the drivers library (with ASan).
981#
982# Parameters:
983# 1. a space-separated list of things to accelerate;
984# *. remaining arguments if any are passed directly to make
985# (examples: lib, -C tests test_suite_xxx, etc.)
986# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
987helper_libtestdriver1_make_main() {
988 loc_accel_list=$1
989 shift
990
991 # we need flags both with and without the LIBTESTDRIVER1_ prefix
992 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
993 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100994 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 +0200995}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100996
997################################################################
998#### Basic checks
999################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001000
1001#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001002# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001003#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001004# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001005# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001006# 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 +02001007# time, so start with a GCC build).
1008# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001009#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001010# Indicative running times are given for reference.
1011
Gilles Peskine8f073122018-11-27 15:58:47 +01001012component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001013 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001014 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001015}
Janos Follathb72c6782016-07-19 14:54:17 +01001016
Gilles Peskine67debb62021-05-18 16:09:50 +02001017component_check_generated_files () {
1018 msg "Check: check-generated-files, files generated with make" # 2s
1019 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001020 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001021
1022 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001023 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001024 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001025 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001026
1027 msg "Check: check-generated-files -u, files absent" # 2s
1028 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001029 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001030 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001031 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001032
1033 # This component ends with the generated files present in the source tree.
1034 # This is necessary for subsequent components!
1035}
1036
Gilles Peskine8f073122018-11-27 15:58:47 +01001037component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001038 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001039 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001040}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001041
Gilles Peskine8f073122018-11-27 15:58:47 +01001042component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001043 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001044 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001045}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001047component_check_changelog () {
1048 msg "Check: changelog entries" # < 1s
1049 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001050 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001051 if [ -e ChangeLog.new ]; then
1052 # Show the diff for information. It isn't an error if the diff is
1053 # non-empty.
1054 diff -u ChangeLog ChangeLog.new || true
1055 rm ChangeLog.new
1056 fi
1057}
1058
Gilles Peskine8f073122018-11-27 15:58:47 +01001059component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001060 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001061 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001062}
Darryl Greena07039c2018-03-13 16:48:16 +00001063
Gilles Peskine895868b2019-09-19 21:30:05 +02001064component_check_test_cases () {
1065 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001066 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001067 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001068 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001069 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001070 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001071 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001072 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001073}
1074
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001075component_check_test_dependencies () {
1076 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001077 # The purpose of this component is to catch unjustified dependencies on
1078 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1079 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1080 # MBEDTLS_PSA_xxx).
1081 #
1082 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1083 # this component is meant to catch. However a few of them are justified,
1084 # mostly by the absence of a PSA equivalent, so this component includes a
1085 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001086
1087 found="check-test-deps-found-$$"
1088 expected="check-test-deps-expected-$$"
1089
1090 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001091 grep 'depends_on' \
1092 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001093 grep -Eo '!?MBEDTLS_[^: ]*' |
1094 grep -v MBEDTLS_PSA_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001095 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001096
Yanray Wang18040ed2023-11-23 21:29:56 +08001097 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001098 rm -f $expected
1099 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1100 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001101 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1102 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001103 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1104 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001105 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1106 # the test code and that's probably the most convenient way of achieving
1107 # the test's goal.
1108 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1109 # No PSA equivalent - we should probably have one in the future.
1110 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1111 # No PSA equivalent - needed by some init tests
1112 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001113
1114 # Compare reality with expectation.
1115 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001116 #
1117 # The output should be empty. When it's not:
1118 # - Each '+' line is a macro that was found but not expected. You want to
1119 # find where that macro occurs, and either replace it with PSA macros, or
1120 # add it to the exceptions list above with a justification.
1121 # - Each '-' line is a macro that was expected but not found; it means the
1122 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001123 diff -U0 $expected $found
1124
1125 rm $found $expected
1126}
1127
Gilles Peskine8f073122018-11-27 15:58:47 +01001128component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001129 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001130 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001131}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001132
Gilles Peskine192c72f2017-12-21 15:59:21 +01001133
Gilles Peskine636c26a2020-03-04 20:46:15 +01001134
Gilles Peskine192c72f2017-12-21 15:59:21 +01001135################################################################
1136#### Build and test many configurations and targets
1137################################################################
1138
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001139component_test_default_out_of_box () {
1140 msg "build: make, default config (out-of-box)" # ~1min
1141 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001142 # Disable fancy stuff
1143 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001144
1145 msg "test: main suites make, default config (out-of-box)" # ~10s
1146 make test
1147
1148 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001149 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001150
1151 msg "program demos: make, default config (out-of-box)" # ~10s
1152 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001153}
1154
Gilles Peskine8f073122018-11-27 15:58:47 +01001155component_test_default_cmake_gcc_asan () {
1156 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001157 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1158 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001159
Gilles Peskine8f073122018-11-27 15:58:47 +01001160 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1161 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001162
Gilles Peskine82b27272019-06-14 18:27:03 +02001163 msg "program demos (ASan build)" # ~10s
1164 tests/scripts/run_demos.py
1165
Gilles Peskine97bea012020-04-23 23:37:45 +02001166 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001167 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001168
Gilles Peskine6848d172023-11-02 19:58:03 +01001169 msg "test: metatests (GCC, ASan build)"
1170 tests/scripts/run-metatests.sh any asan
1171
Gilles Peskine8f073122018-11-27 15:58:47 +01001172 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001173 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001174
Gilles Peskine8f073122018-11-27 15:58:47 +01001175 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001176 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001177
1178 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001179 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001180}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001181
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001182component_test_default_cmake_gcc_asan_new_bignum () {
1183 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001184 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001185 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001186 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001187
1188 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1189 make test
1190
1191 msg "test: selftest (ASan build)" # ~ 10s
1192 programs/test/selftest
1193
1194 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1195 tests/ssl-opt.sh
1196
1197 msg "test: compat.sh (ASan build)" # ~ 6 min
1198 tests/compat.sh
1199
1200 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1201 tests/context-info.sh
1202}
1203
Hanno Becker01635512019-02-26 14:27:09 +00001204component_test_full_cmake_gcc_asan () {
1205 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001206 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001207 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1208 make
1209
1210 msg "test: main suites (inc. selftests) (full config, ASan build)"
1211 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001212
Gilles Peskine97bea012020-04-23 23:37:45 +02001213 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001214 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001215
Gilles Peskine636c26a2020-03-04 20:46:15 +01001216 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001217 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001218
1219 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001220 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001221
1222 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001223 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001224}
1225
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001226
1227component_test_full_cmake_gcc_asan_new_bignum () {
1228 msg "build: full config, cmake, gcc, ASan"
1229 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001230 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001231 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001232 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001233
1234 msg "test: main suites (inc. selftests) (full config, ASan build)"
1235 make test
1236
1237 msg "test: selftest (ASan build)" # ~ 10s
1238 programs/test/selftest
1239
1240 msg "test: ssl-opt.sh (full config, ASan build)"
1241 tests/ssl-opt.sh
1242
1243 msg "test: compat.sh (full config, ASan build)"
1244 tests/compat.sh
1245
1246 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1247 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001248}
1249
Ronald Cronc3623db2020-10-29 10:51:32 +01001250component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001251 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001252 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001253 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1254 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1255 make
1256
1257 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1258 make test
1259}
1260
Gilles Peskinea3548672021-06-17 11:37:52 +02001261# check_renamed_symbols HEADER LIB
1262# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1263# name is LIB.
1264check_renamed_symbols () {
1265 ! nm "$2" | sed 's/.* //' |
1266 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1267}
1268
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001269component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001270 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001271 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001272 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1273 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1274 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1275 # We can only compile, not link, since our test and sample programs
1276 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1277 # is active.
1278 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001279
1280 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1281 # version is not present.
1282 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001283 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001284}
1285
Ronald Cron336678b2021-01-28 17:54:24 +01001286component_test_psa_crypto_client () {
1287 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1288 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1289 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1290 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001291 scripts/config.py unset MBEDTLS_LMS_C
1292 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Ronald Cron336678b2021-01-28 17:54:24 +01001293 make
1294
1295 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1296 make test
1297}
1298
Jaeden Amero424fa932021-05-14 08:34:32 +01001299component_test_psa_crypto_rsa_no_genprime() {
1300 msg "build: default config minus MBEDTLS_GENPRIME"
1301 scripts/config.py unset MBEDTLS_GENPRIME
1302 make
1303
1304 msg "test: default config minus MBEDTLS_GENPRIME"
1305 make test
1306}
1307
Gilles Peskine782f4112018-11-27 16:11:09 +01001308component_test_ref_configs () {
1309 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001310 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1311 # want to re-generate generated files that depend on it, quite correctly.
1312 # However this doesn't work as the generation script expects a specific
1313 # format for mbedtls_config.h, which the other files don't follow. Also,
1314 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001315 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001316 # whether they're on or off. So, disable cmake's (over-sensitive here)
1317 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001318 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001319 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001320 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001321}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001322
Gilles Peskine8f073122018-11-27 15:58:47 +01001323component_test_no_renegotiation () {
1324 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001325 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001326 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001327 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001328
Gilles Peskine8f073122018-11-27 15:58:47 +01001329 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1330 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001331
Gilles Peskine8f073122018-11-27 15:58:47 +01001332 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001333 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001334}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001335
Gilles Peskine636c26a2020-03-04 20:46:15 +01001336component_test_no_pem_no_fs () {
1337 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1338 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1339 scripts/config.py unset MBEDTLS_FS_IO
1340 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1341 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001342 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001343 make
1344
1345 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1346 make test
1347
1348 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001349 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001350}
1351
Gilles Peskine8f073122018-11-27 15:58:47 +01001352component_test_rsa_no_crt () {
1353 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001354 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001355 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001356 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001357
Gilles Peskine8f073122018-11-27 15:58:47 +01001358 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1359 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001360
Gilles Peskine8f073122018-11-27 15:58:47 +01001361 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001362 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001363
Gilles Peskine8f073122018-11-27 15:58:47 +01001364 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001365 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001366
1367 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001368 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001369}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001370
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001371component_test_no_ctr_drbg_classic () {
1372 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001373 scripts/config.py full
1374 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001375 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001376 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001377
Dave Rodgman17127e92023-12-14 16:42:48 +00001378 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001379 make
1380
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001381 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001382 make test
1383
Gilles Peskineba749042021-01-13 20:02:03 +01001384 # In this configuration, the TLS test programs use HMAC_DRBG.
1385 # The SSL tests are slow, so run a small subset, just enough to get
1386 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001387 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001388 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001389
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001390 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001391 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001392}
1393
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001394component_test_no_ctr_drbg_use_psa () {
1395 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001396 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001397 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1398 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001399
Dave Rodgman17127e92023-12-14 16:42:48 +00001400 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001401 make
1402
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001403 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1404 make test
1405
1406 # In this configuration, the TLS test programs use HMAC_DRBG.
1407 # The SSL tests are slow, so run a small subset, just enough to get
1408 # confidence that the SSL code copes with HMAC_DRBG.
1409 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001410 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001411
1412 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001413 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001414}
1415
1416component_test_no_hmac_drbg_classic () {
1417 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1418 scripts/config.py full
1419 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1420 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1421 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001422 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001423
Dave Rodgman17127e92023-12-14 16:42:48 +00001424 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001425 make
1426
1427 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001428 make test
1429
Gilles Peskinea2224342020-11-19 22:14:34 +01001430 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1431 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1432 # instead.
1433 # Test SSL with non-deterministic ECDSA. Only test features that
1434 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001435 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001436 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001437
1438 # To save time, only test one protocol version, since this part of
1439 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001440 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001441 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001442}
1443
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001444component_test_no_hmac_drbg_use_psa () {
1445 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1446 scripts/config.py full
1447 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1448 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1449 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1450
Dave Rodgman17127e92023-12-14 16:42:48 +00001451 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001452 make
1453
1454 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1455 make test
1456
1457 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1458 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1459 # instead.
1460 # Test SSL with non-deterministic ECDSA. Only test features that
1461 # might be affected by how ECDSA signature is performed.
1462 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001463 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001464
1465 # To save time, only test one protocol version, since this part of
1466 # the protocol is identical in (D)TLS up to 1.2.
1467 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001468 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001469}
1470
1471component_test_psa_external_rng_no_drbg_classic () {
1472 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1473 scripts/config.py full
1474 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001475 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001476 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001477 scripts/config.py unset MBEDTLS_ENTROPY_C
1478 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1479 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001480 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1481 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1482 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001483 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1484 # the SSL test programs don't have an RNG and can't work. Explicitly
1485 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001486 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001487
1488 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1489 make test
1490
Gilles Peskine8eb29432021-02-03 20:07:11 +01001491 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001492 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001493}
1494
1495component_test_psa_external_rng_no_drbg_use_psa () {
1496 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001497 scripts/config.py full
1498 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001499 scripts/config.py unset MBEDTLS_ENTROPY_C
1500 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1501 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001502 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1503 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1504 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001505 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001506
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001508 make test
1509
Gilles Peskine8eb29432021-02-03 20:07:11 +01001510 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001511 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001512}
1513
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001514component_test_psa_external_rng_use_psa_crypto () {
1515 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1516 scripts/config.py full
1517 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1518 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1519 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001520 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001521
1522 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1523 make test
1524
1525 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1526 tests/ssl-opt.sh -f 'Default\|opaque'
1527}
1528
Gilles Peskine801c4332023-04-28 21:04:28 +02001529component_test_psa_inject_entropy () {
1530 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1531 scripts/config.py full
1532 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1533 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1534 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1535 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1536 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1537 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001538 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 +02001539
1540 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1541 make test
1542}
1543
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001544component_test_sw_inet_pton () {
1545 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1546
1547 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1548 scripts/config.py set MBEDTLS_TEST_HOOKS
1549 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1550
1551 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1552 make test
1553}
1554
Valerio Settia41654d2024-02-08 10:33:11 +01001555component_full_no_pkparse_pkwrite() {
1556 msg "build: full without pkparse and pkwrite"
1557
1558 scripts/config.py crypto_full
1559 scripts/config.py unset MBEDTLS_PK_PARSE_C
1560 scripts/config.py unset MBEDTLS_PK_WRITE_C
1561
1562 # Disable features that re-enable PK_PARSE_C
1563 scripts/config.py unset MBEDTLS_RSA_C
1564 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all PSA_WANT_ALG_RSA
1565 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all PSA_WANT_KEY_TYPE_RSA
1566
1567 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1568
1569 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1570 not grep mbedtls_pk_parse_key library/pkparse.o
1571 not grep mbedtls_pk_write_key_der library/pkwrite.o
1572
1573 msg "test: full without pkparse and pkwrite"
1574 make test
1575}
1576
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001577component_test_crypto_full_md_light_only () {
1578 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001579 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001580 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001581 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001582 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001583 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001584 scripts/config.py unset MBEDTLS_HKDF_C
1585 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001586 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001587 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001588 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001589 # Disable things that would auto-enable MD_C
1590 scripts/config.py unset MBEDTLS_PKCS5_C
1591
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001592 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1593 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001594 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001595
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001596 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001597 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001598 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001599
1600 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001601 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001602}
1603
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001604component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001605 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001606 scripts/config.py full
1607 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001608 # Don't pull in cipher via PSA mechanisms
1609 # (currently ignored anyway because we completely disable PSA)
1610 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001611 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001612 scripts/config.py unset MBEDTLS_CMAC_C
1613 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001614 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001615 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001616 scripts/config.py unset MBEDTLS_SSL_TLS_C
1617 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001618 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001619 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1620 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001621 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001622 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001623 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001624
Valerio Settidf17a102023-10-23 14:14:19 +02001625 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001626 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001627}
1628
Valerio Setti7e710e82023-08-25 09:14:15 +02001629# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001630# - component_test_full_no_cipher_with_psa_crypto
1631# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001632# It accepts 2 input parameters:
1633# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1634# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001635common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001636 USE_CRYPTO_CONFIG="$1"
1637 COMPONENT_DESCRIPTION="$2"
1638
1639 msg "build: $COMPONENT_DESCRIPTION"
1640
1641 scripts/config.py full
1642 scripts/config.py unset MBEDTLS_CIPHER_C
1643
1644 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001645 # The built-in implementation of the following algs/key-types depends
1646 # on CIPHER_C so we disable them.
1647 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1648 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001649 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001650 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1651 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1652 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1653 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1654 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1655 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1656 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1657 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001658 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001659 else
1660 # Don't pull in cipher via PSA mechanisms
1661 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001662 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1663 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1664 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001665 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001666 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001667 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001668 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001669
Gilles Peskine21570cf2023-12-22 11:49:50 +01001670 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001671
Valerio Setti7e710e82023-08-25 09:14:15 +02001672 # Ensure that CIPHER_C was not re-enabled
1673 not grep mbedtls_cipher_init library/cipher.o
1674
1675 msg "test: $COMPONENT_DESCRIPTION"
1676 make test
1677}
1678
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001679component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001680 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001681}
1682
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001683component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001684 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001685}
1686
Valerio Settibdfecb62023-11-07 15:37:20 +01001687component_test_full_no_ccm() {
1688 msg "build: full no PSA_WANT_ALG_CCM"
1689
1690 # Full config enables:
1691 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1692 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1693 scripts/config.py full
1694
1695 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1696 # enabled, but not used from TLS since USE_PSA is set.
1697 # This is helpful to ensure that TLS tests below have proper dependencies.
1698 #
1699 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1700 # PSA_WANT_ALG_CCM to be re-enabled.
1701 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1702
Gilles Peskine21570cf2023-12-22 11:49:50 +01001703 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001704
1705 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001706 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001707}
1708
1709component_test_full_no_ccm_star_no_tag() {
1710 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1711
1712 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1713 scripts/config.py full
1714
1715 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1716 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1717 # This basically disables all unauthenticated ciphers on the PSA side, while
1718 # keeping AEADs enabled.
1719 #
1720 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1721 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1722 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1723 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1724 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1725 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1726 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1727 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1728 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1729 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1730
Gilles Peskine21570cf2023-12-22 11:49:50 +01001731 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001732
1733 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001734 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001735
1736 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001737 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001738}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001739
Valerio Settie1655b82023-01-03 15:35:25 +01001740component_test_full_no_bignum () {
1741 msg "build: full minus bignum"
1742 scripts/config.py full
1743 scripts/config.py unset MBEDTLS_BIGNUM_C
1744 # Direct dependencies of bignum
1745 scripts/config.py unset MBEDTLS_ECP_C
1746 scripts/config.py unset MBEDTLS_RSA_C
1747 scripts/config.py unset MBEDTLS_DHM_C
1748 # Direct dependencies of ECP
1749 scripts/config.py unset MBEDTLS_ECDH_C
1750 scripts/config.py unset MBEDTLS_ECDSA_C
1751 scripts/config.py unset MBEDTLS_ECJPAKE_C
1752 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001753 # Disable what auto-enables ECP_LIGHT
1754 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1755 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001756 # Indirect dependencies of ECP
1757 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1758 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1759 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1760 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1761 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1762 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1763 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1764 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1765 # Direct dependencies of DHM
1766 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1767 # Direct dependencies of RSA
1768 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1769 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1770 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1771 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1772 # PK and its dependencies
1773 scripts/config.py unset MBEDTLS_PK_C
1774 scripts/config.py unset MBEDTLS_PK_PARSE_C
1775 scripts/config.py unset MBEDTLS_PK_WRITE_C
1776 scripts/config.py unset MBEDTLS_X509_USE_C
1777 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1778 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1779 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1780 scripts/config.py unset MBEDTLS_X509_CREATE_C
1781 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1782 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1783 scripts/config.py unset MBEDTLS_PKCS7_C
1784 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1785 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1786 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1787
Gilles Peskine21570cf2023-12-22 11:49:50 +01001788 make
Valerio Settie1655b82023-01-03 15:35:25 +01001789
1790 msg "test: full minus bignum"
1791 make test
1792}
1793
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001794component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001795 msg "build: default with only stream cipher"
1796
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001797 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001798 scripts/config.py unset MBEDTLS_GCM_C
1799 scripts/config.py unset MBEDTLS_CCM_C
1800 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001801 # 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 +02001802 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001803 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001804 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001805 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1806 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001807 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001808 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001809 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001810
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001811 make
1812
1813 msg "test: default with only stream cipher"
1814 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001815
1816 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001817}
1818
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001819component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001820 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001821
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001822 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001823 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001824 scripts/config.py unset MBEDTLS_GCM_C
1825 scripts/config.py unset MBEDTLS_CCM_C
1826 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001827 # 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 +02001828 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001829 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001830 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001831 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1832 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001833 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001834 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001835 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001836
Przemek Stekiel9550c052022-09-28 09:51:55 +02001837 make
1838
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001839 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001840 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001841
1842 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001843}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001844
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001845component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001846 msg "build: default with only CBC-legacy cipher"
1847
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001848 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001849 scripts/config.py unset MBEDTLS_GCM_C
1850 scripts/config.py unset MBEDTLS_CCM_C
1851 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001852 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1853 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1854 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001855 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001856 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001857 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001858 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001859 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001860 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001861
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001862 make
1863
1864 msg "test: default with only CBC-legacy cipher"
1865 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001866
1867 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1868 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001869}
1870
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001871component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001872 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001873
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001874 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001875 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001876 scripts/config.py unset MBEDTLS_GCM_C
1877 scripts/config.py unset MBEDTLS_CCM_C
1878 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001879 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1880 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1881 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001882 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001883 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001884 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001885 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001886 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001887 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001888
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001889 make
1890
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001891 msg "test: default with only CBC-legacy cipher use psa"
1892 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001893
1894 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1895 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001896}
1897
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001898component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001899 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1900
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001901 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001902 scripts/config.py unset MBEDTLS_GCM_C
1903 scripts/config.py unset MBEDTLS_CCM_C
1904 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001905 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1906 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1907 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1908 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1909 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001910 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001911 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001912 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001913 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001914
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001915 make
1916
1917 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1918 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001919
1920 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1921 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001922}
1923
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001924component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1925 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001926
1927 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001928 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001929 scripts/config.py unset MBEDTLS_GCM_C
1930 scripts/config.py unset MBEDTLS_CCM_C
1931 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001932 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1933 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1934 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1935 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1936 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001937 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001938 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001939 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001940 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001941
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001942 make
1943
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001944 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001945 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001946
1947 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1948 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001949}
1950
Valerio Setti9f0ec532022-11-08 13:03:24 +01001951# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1952# that we could use for interop testing. However, we now have sort of two
1953# implementations ourselves: one using PSA, the other not. At least test that
1954# these two interoperate with each other.
1955component_test_tls1_2_ecjpake_compatibility() {
1956 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1957 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001958 # Explicitly make lib first to avoid a race condition:
1959 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1960 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001961 make -C programs ssl/ssl_server2 ssl/ssl_client2
1962 cp programs/ssl/ssl_server2 s2_no_use_psa
1963 cp programs/ssl/ssl_client2 c2_no_use_psa
1964
1965 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1966 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1967 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001968 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001969 make -C programs ssl/ssl_server2 ssl/ssl_client2
1970 make -C programs test/udp_proxy test/query_compile_time_config
1971
Valerio Setti70e02902022-12-02 16:21:56 +01001972 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1973 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1974 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1975 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1976 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1977 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1978 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1979 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 +01001980
1981 rm s2_no_use_psa c2_no_use_psa
1982}
1983
Gilles Peskine636c26a2020-03-04 20:46:15 +01001984component_test_everest () {
1985 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
1986 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1987 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1988 make
1989
1990 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1991 make test
1992
Gilles Peskine6848d172023-11-02 19:58:03 +01001993 msg "test: metatests (clang, ASan)"
1994 tests/scripts/run-metatests.sh any asan
1995
Gilles Peskine636c26a2020-03-04 20:46:15 +01001996 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
1997 tests/ssl-opt.sh -f ECDH
1998
1999 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2000 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002001 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002002}
2003
Gilles Peskined3beca92020-07-03 00:15:37 +02002004component_test_everest_curve25519_only () {
2005 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002006 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2007 scripts/config.py unset MBEDTLS_ECDSA_C
2008 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2009 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002010 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002011 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002012 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002013 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2014
Dave Rodgman17127e92023-12-14 16:42:48 +00002015 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002016
2017 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2018 make test
2019}
2020
Gilles Peskine8f073122018-11-27 15:58:47 +01002021component_test_small_ssl_out_content_len () {
2022 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002023 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2024 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002025 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002026 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002027
Gilles Peskine8f073122018-11-27 15:58:47 +01002028 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002029 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002030}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002031
Gilles Peskine8f073122018-11-27 15:58:47 +01002032component_test_small_ssl_in_content_len () {
2033 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002034 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2035 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002036 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002037 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002038
Gilles Peskine8f073122018-11-27 15:58:47 +01002039 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002040 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002041}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002042
Gilles Peskine8f073122018-11-27 15:58:47 +01002043component_test_small_ssl_dtls_max_buffering () {
2044 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002045 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002046 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002047 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002048
Gilles Peskine8f073122018-11-27 15:58:47 +01002049 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002050 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 +01002051}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002052
Gilles Peskine8f073122018-11-27 15:58:47 +01002053component_test_small_mbedtls_ssl_dtls_max_buffering () {
2054 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002055 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002056 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002057 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002058
Gilles Peskine8f073122018-11-27 15:58:47 +01002059 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002060 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002061}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002062
Gilles Peskine75cc7712019-09-06 19:47:17 +02002063component_test_psa_collect_statuses () {
2064 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002065 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002066 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002067 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002068 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002069 rm -f tests/statuses.log
2070}
2071
Gilles Peskine8f073122018-11-27 15:58:47 +01002072component_test_full_cmake_clang () {
2073 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002074 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002075 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 +01002076 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002077
k-stachowiak0291cb72019-06-26 15:52:12 +02002078 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002079 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002080
Gilles Peskineda6017c2022-10-30 21:02:40 +01002081 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2082 programs/test/cpp_dummy_build
2083
Gilles Peskine6848d172023-11-02 19:58:03 +01002084 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002085 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002086
Gilles Peskine82b27272019-06-14 18:27:03 +02002087 msg "program demos (full config, clang)" # ~10s
2088 tests/scripts/run_demos.py
2089
k-stachowiak0291cb72019-06-26 15:52:12 +02002090 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002091 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002092
Gilles Peskine8f073122018-11-27 15:58:47 +01002093 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002094 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002095
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002096 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002097 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002098
Gilles Peskine8f073122018-11-27 15:58:47 +01002099 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002100 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002101}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002102
Gilles Peskine0c671602022-11-29 16:01:41 +01002103skip_suites_without_constant_flow () {
2104 # Skip the test suites that don't have any constant-flow annotations.
2105 # This will need to be adjusted if we ever start declaring things as
2106 # secret from macros or functions inside tests/include or tests/src.
2107 SKIP_TEST_SUITES=$(
2108 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2109 sed 's/test_suite_//; s/\.function$//' |
2110 tr '\n' ,)
2111 export SKIP_TEST_SUITES
2112}
2113
Dave Rodgman246210e2023-07-31 18:07:44 +01002114skip_all_except_given_suite () {
2115 # Skip all but the given test suite
2116 SKIP_TEST_SUITES=$(
2117 ls -1 tests/suites/test_suite_*.function |
2118 grep -v $1.function |
2119 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2120 tr '\n' ,)
2121 export SKIP_TEST_SUITES
2122}
2123
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002124component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002125 # This tests both (1) accesses to undefined memory, and (2) branches or
2126 # memory access depending on secret values. To distinguish between those:
2127 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2128 # - or alternatively, change the build type to MemSanDbg, which enables
2129 # origin tracking and nicer stack traces (which are useful for debugging
2130 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002131 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2132 scripts/config.py full
2133 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2134 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2135 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2136 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2137 make
2138
2139 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2140 make test
2141}
2142
2143component_test_memsan_constant_flow_psa () {
2144 # This tests both (1) accesses to undefined memory, and (2) branches or
2145 # memory access depending on secret values. To distinguish between those:
2146 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2147 # - or alternatively, change the build type to MemSanDbg, which enables
2148 # origin tracking and nicer stack traces (which are useful for debugging
2149 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002150 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002151 scripts/config.py full
2152 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2153 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2154 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2155 make
2156
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002157 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002158 make test
2159}
2160
Bence Szépkúti0354d042023-12-06 16:14:37 +01002161component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002162 # This tests both (1) everything that valgrind's memcheck usually checks
2163 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2164 # etc.) and (2) branches or memory access depending on secret values,
2165 # which will be reported as uninitialized memory. To distinguish between
2166 # secret and actually uninitialized:
2167 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2168 # - or alternatively, build with debug info and manually run the offending
2169 # test suite with valgrind --track-origins=yes, then check if the origin
2170 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002171 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2172 scripts/config.py full
2173 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2174 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002175 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002176 cmake -D CMAKE_BUILD_TYPE:String=Release .
2177 make
2178
2179 # this only shows a summary of the results (how many of each type)
2180 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002181 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002182 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002183
2184 # Test asm path in constant time module - by default, it will test the plain C
2185 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2186 msg "test: valgrind asm constant_time"
2187 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2188 skip_all_except_given_suite test_suite_constant_time
2189 cmake -D CMAKE_BUILD_TYPE:String=Release .
2190 make clean
2191 make
2192 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002193}
2194
Bence Szépkúti0354d042023-12-06 16:14:37 +01002195component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002196 # This tests both (1) everything that valgrind's memcheck usually checks
2197 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2198 # etc.) and (2) branches or memory access depending on secret values,
2199 # which will be reported as uninitialized memory. To distinguish between
2200 # secret and actually uninitialized:
2201 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2202 # - or alternatively, build with debug info and manually run the offending
2203 # test suite with valgrind --track-origins=yes, then check if the origin
2204 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002205 msg "build: cmake release GCC, full config with constant flow testing"
2206 scripts/config.py full
2207 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002208 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002209 cmake -D CMAKE_BUILD_TYPE:String=Release .
2210 make
2211
2212 # this only shows a summary of the results (how many of each type)
2213 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002214 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002215 make memcheck
2216}
2217
Janos Follath9338cac2023-10-04 18:55:39 +01002218component_test_tsan () {
2219 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002220 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002221 scripts/config.py set MBEDTLS_THREADING_C
2222 scripts/config.py set MBEDTLS_THREADING_PTHREAD
2223
2224 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2225 make
2226
2227 msg "test: main suites (TSan)"
2228 make test
2229}
2230
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002231component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002232 # Test that removing the deprecated features from the default
2233 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002234 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2235 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002236 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002237
2238 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2239 make test
2240}
2241
2242component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002243 msg "build: make, full_no_deprecated config" # ~ 30s
2244 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002245 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002246
Gilles Peskine30de2e82020-04-20 21:39:22 +02002247 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002248 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002249
2250 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2251 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002252}
2253
Gilles Peskine8386ea22020-04-30 09:07:29 +02002254component_test_full_no_deprecated_deprecated_warning () {
2255 # Test that there is nothing deprecated in "full_no_deprecated".
2256 # A deprecated feature would trigger a warning (made fatal) from
2257 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002258 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2259 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002260 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2261 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002262 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002263
Gilles Peskine30de2e82020-04-20 21:39:22 +02002264 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002265 make test
2266}
2267
Gilles Peskine8386ea22020-04-30 09:07:29 +02002268component_test_full_deprecated_warning () {
2269 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2270 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002271 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002272 scripts/config.py full
2273 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002274 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002275 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2276 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002277 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002278
Gilles Peskine8386ea22020-04-30 09:07:29 +02002279 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2280 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2281 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002282 # Expect warnings from '#warning' directives in check_config.h and
2283 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002284 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 +01002285
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002286 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2287 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002288
2289 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2290 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002291}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002292
Gilles Peskineec541fe2020-01-31 14:24:14 +01002293# Check that the specified libraries exist and are empty.
2294are_empty_libraries () {
2295 nm "$@" >/dev/null 2>/dev/null
2296 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2297}
2298
2299component_build_crypto_default () {
2300 msg "build: make, crypto only"
2301 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002302 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002303 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002304}
2305
2306component_build_crypto_full () {
2307 msg "build: make, crypto only, full config"
2308 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002309 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002310 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002311}
2312
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002313component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002314 msg "build: make, config for PSA crypto service"
2315 scripts/config.py crypto
2316 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2317 # Disable things that are not needed for just cryptography, to
2318 # reach a configuration that would be typical for a PSA cryptography
2319 # service providing all implemented PSA algorithms.
2320 # System stuff
2321 scripts/config.py unset MBEDTLS_ERROR_C
2322 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002323 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002324 # Crypto stuff with no PSA interface
2325 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002326 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002327 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002328 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002329 scripts/config.py unset MBEDTLS_NIST_KW_C
2330 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2331 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2332 scripts/config.py unset MBEDTLS_PKCS12_C
2333 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002334 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2335 # in PSA code to work with RSA keys. We don't require users to set those:
2336 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002337 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002338 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002339 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002340 make CFLAGS='-O1 -Werror' all test
2341 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2342}
2343
Gilles Peskineec541fe2020-01-31 14:24:14 +01002344component_build_crypto_baremetal () {
2345 msg "build: make, crypto only, baremetal config"
2346 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002347 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002348 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002349}
Daniel Axtens446af202020-09-02 21:30:13 +10002350support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002351 support_build_baremetal "$@"
2352}
2353
2354component_build_baremetal () {
2355 msg "build: make, baremetal config"
2356 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002357 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002358}
2359support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002360 # Older Glibc versions include time.h from other headers such as stdlib.h,
2361 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2362 # problem, Ubuntu 18.04 is ok.
2363 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2364}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002365
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002366# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002367component_test_depends_py_cipher_id () {
2368 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002369 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002370}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002371
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002372component_test_depends_py_cipher_chaining () {
2373 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002374 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002375}
2376
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002377component_test_depends_py_cipher_padding () {
2378 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002379 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002380}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002381
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002382component_test_depends_py_curves () {
2383 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002384 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002385}
2386
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002387component_test_depends_py_hashes () {
2388 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002389 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002390}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002391
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002392component_test_depends_py_kex () {
2393 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002394 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002395}
2396
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002397component_test_depends_py_pkalgs () {
2398 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002399 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002400}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002401
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002402# PSA equivalents of the depends.py tests
2403component_test_depends_py_cipher_id_psa () {
2404 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002405 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002406}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002407
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002408component_test_depends_py_cipher_chaining_psa () {
2409 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002410 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002411}
2412
2413component_test_depends_py_cipher_padding_psa () {
2414 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002415 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002416}
2417
2418component_test_depends_py_curves_psa () {
2419 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002420 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002421}
2422
2423component_test_depends_py_hashes_psa () {
2424 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002425 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002426}
2427
2428component_test_depends_py_kex_psa () {
2429 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002430 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002431}
2432
2433component_test_depends_py_pkalgs_psa () {
2434 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002435 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002436}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002437
Valerio Setti6bed64e2024-01-17 15:21:44 +01002438component_test_psa_crypto_config_ffdh_2048_only () {
2439 msg "build: full config - only DH 2048"
2440
2441 scripts/config.py full
2442
2443 # Disable all DH groups other than 2048.
2444 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2445 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2446 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2447 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2448
2449 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2450
2451 msg "test: full config - only DH 2048"
2452 make test
2453
2454 msg "ssl-opt: full config - only DH 2048"
2455 tests/ssl-opt.sh -f "ffdh"
2456}
2457
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002458component_build_no_pk_rsa_alt_support () {
2459 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2460
2461 scripts/config.py full
2462 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2463 scripts/config.py set MBEDTLS_RSA_C
2464 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2465
2466 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002467 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002468}
2469
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002470component_build_module_alt () {
2471 msg "build: MBEDTLS_XXX_ALT" # ~30s
2472 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002473
2474 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002475 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2476 scripts/config.py unset MBEDTLS_AESNI_C
2477 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002478 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002479 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2480 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002481 # You can only have one threading implementation: alt or pthread, not both.
2482 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002483 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2484 # directly and assumes the implementation works with partial groups.
2485 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002486 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2487 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2488 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002489 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2490 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2491 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002492
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002493 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2494 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2495 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002496 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002497
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002498 # We can only compile, not link, since we don't have any implementations
2499 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002500 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002501}
2502
2503component_build_dhm_alt () {
2504 msg "build: MBEDTLS_DHM_ALT" # ~30s
2505 scripts/config.py full
2506 scripts/config.py set MBEDTLS_DHM_ALT
2507 # debug.c currently references mbedtls_dhm_context fields directly.
2508 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002509 # We can only compile, not link, since we don't have any implementations
2510 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002511 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002512}
2513
Gilles Peskine64996c32024-01-23 20:25:47 +01002514component_test_no_psa_crypto_full_cmake_asan() {
2515 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2516 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002517 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002518 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002519 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002520 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002521 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002522 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002523 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002524 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002525 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002526 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002527 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002528 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002529
Gilles Peskine64996c32024-01-23 20:25:47 +01002530 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002531 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002532
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002533 # Note: ssl-opt.sh has some test cases that depend on
2534 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2535 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002536 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002537 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002538
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002539 msg "test: compat.sh default (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002540 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002541
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002542 msg "test: compat.sh NULL (full minus PSA crypto)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002543 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002544
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002545 msg "test: compat.sh ARIA + ChachaPoly (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002546 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002547}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002548
Ronald Cron403c15c2021-09-13 09:38:05 +02002549component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002550 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002551
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002552 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002553 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002554 $(helper_get_psa_key_type_list "ECC") \
2555 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002556
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002557 # Configure
2558 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002559
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002560 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002561 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard6d7db932022-12-28 09:48:01 +01002562 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002563
2564 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002565 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002566
2567 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002568 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2569 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2570
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002571 # Build
2572 # -----
2573
2574 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002575 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2576 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002577
2578 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2579
Valerio Setti3fe105b2023-10-30 11:08:12 +01002580 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002581
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002582 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002583 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002584
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002585 # Run the tests
2586 # -------------
2587
Ronald Cron403c15c2021-09-13 09:38:05 +02002588 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2589 make test
2590}
2591
Valerio Setti44b178c2023-03-22 14:02:57 +01002592component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002593 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002594
2595 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002596 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002597 $(helper_get_psa_key_type_list "ECC") \
2598 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002599
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002600 # Configure
2601 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002602
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002603 # Start from default config (no TLS 1.3, no USE_PSA)
2604 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002605
Valerio Setti44b178c2023-03-22 14:02:57 +01002606 # Disable the module that's accelerated
2607 scripts/config.py unset MBEDTLS_ECDH_C
2608
2609 # Disable things that depend on it
2610 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2611 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2612 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2613 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2614 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2615
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002616 # Build
2617 # -----
2618
2619 helper_libtestdriver1_make_drivers "$loc_accel_list"
2620
Valerio Setti3fe105b2023-10-30 11:08:12 +01002621 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002622
Valerio Setti44b178c2023-03-22 14:02:57 +01002623 # Make sure this was not re-enabled by accident (additive config)
2624 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002625
2626 # Run the tests
2627 # -------------
2628
Valerio Setti44b178c2023-03-22 14:02:57 +01002629 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002630 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002631}
2632
Przemek Stekieldccb2022023-05-11 10:48:50 +02002633component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002634 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002635
2636 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002637 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002638 $(helper_get_psa_key_type_list "DH") \
2639 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002640
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002641 # Configure
2642 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002643
Przemek Stekiel565353e2023-07-05 11:07:07 +02002644 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002645 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002646
2647 # Disable the module that's accelerated
2648 scripts/config.py unset MBEDTLS_DHM_C
2649
2650 # Disable things that depend on it
2651 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2652 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2653
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002654 # Build
2655 # -----
2656
2657 helper_libtestdriver1_make_drivers "$loc_accel_list"
2658
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002659 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002660
2661 # Make sure this was not re-enabled by accident (additive config)
2662 not grep mbedtls_dhm_ library/dhm.o
2663
2664 # Run the tests
2665 # -------------
2666
Gilles Peskine14302ed2023-07-19 19:30:04 +02002667 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002668 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002669
Gilles Peskine14302ed2023-07-19 19:30:04 +02002670 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002671 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002672}
2673
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002674component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002675 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002676
2677 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002678 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002679
2680 # Disable things that are not supported
2681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2682 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002683 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002684
Gilles Peskine14302ed2023-07-19 19:30:04 +02002685 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002686 make test
2687
Gilles Peskine14302ed2023-07-19 19:30:04 +02002688 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002689 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002690}
2691
Valerio Setti44b178c2023-03-22 14:02:57 +01002692component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002693 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002694
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002695 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002696 $(helper_get_psa_key_type_list "ECC") \
2697 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002698
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002699 # Configure
2700 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002701
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002702 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002703
2704 # Make built-in fallback not available
2705 scripts/config.py unset MBEDTLS_ECJPAKE_C
2706 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2707
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002708 # Build
2709 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002710
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002711 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002712
Valerio Setti3fe105b2023-10-30 11:08:12 +01002713 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002714
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002715 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002716 not grep mbedtls_ecjpake_init library/ecjpake.o
2717
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002718 # Run the tests
2719 # -------------
2720
Gilles Peskine14302ed2023-07-19 19:30:04 +02002721 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002722 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002723}
2724
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002725component_test_psa_crypto_config_accel_ecc_some_key_types () {
2726 msg "build: full with accelerated EC algs and some key types"
2727
2728 # Algorithms and key types to accelerate
2729 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2730 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2731 ALG_ECDH \
2732 ALG_JPAKE \
2733 KEY_TYPE_ECC_PUBLIC_KEY \
2734 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2735 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002736 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2737 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002738
2739 # Configure
2740 # ---------
2741
2742 # start with config full for maximum coverage (also enables USE_PSA)
2743 helper_libtestdriver1_adjust_config "full"
2744
2745 # Disable modules that are accelerated - some will be re-enabled
2746 scripts/config.py unset MBEDTLS_ECDSA_C
2747 scripts/config.py unset MBEDTLS_ECDH_C
2748 scripts/config.py unset MBEDTLS_ECJPAKE_C
2749 scripts/config.py unset MBEDTLS_ECP_C
2750
2751 # Disable all curves - those that aren't accelerated should be re-enabled
2752 helper_disable_builtin_curves
2753
2754 # Restartable feature is not yet supported by PSA. Once it will in
2755 # the future, the following line could be removed (see issues
2756 # 6061, 6332 and following ones)
2757 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2758
2759 # this is not supported by the driver API yet
2760 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2761
2762 # Build
2763 # -----
2764
2765 # These hashes are needed for some ECDSA signature tests.
2766 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2767 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2768 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2769
Valerio Setti3fe105b2023-10-30 11:08:12 +01002770 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002771
2772 # ECP should be re-enabled but not the others
2773 not grep mbedtls_ecdh_ library/ecdh.o
2774 not grep mbedtls_ecdsa library/ecdsa.o
2775 not grep mbedtls_ecjpake library/ecjpake.o
2776 grep mbedtls_ecp library/ecp.o
2777
2778 # Run the tests
2779 # -------------
2780
2781 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002782 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002783}
2784
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002785# Run tests with only (non-)Weierstrass accelerated
2786# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002787# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2788# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002789common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002790 weierstrass=$1
2791 if [ $weierstrass -eq 1 ]; then
2792 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002793 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002794 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002795 fi
2796
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002797 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002798
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002799 # Note: Curves are handled in a special way by the libtestdriver machinery,
2800 # so we only want to include them in the accel list when building the main
2801 # libraries, hence the use of a separate variable.
2802 # Note: the following loop is a modified version of
2803 # helper_get_psa_curve_list that only keeps Weierstrass families.
2804 loc_weierstrass_list=""
2805 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002806 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2807 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002808 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002809 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002810 ;;
2811 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002812 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002813 ;;
2814 esac
2815 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002816 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002817 loc_curve_list=$loc_weierstrass_list
2818 else
2819 loc_curve_list=$loc_non_weierstrass_list
2820 fi
2821
Valerio Setti3fe105b2023-10-30 11:08:12 +01002822 # Algorithms and key types to accelerate
2823 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2824 ALG_ECDH \
2825 ALG_JPAKE \
2826 $(helper_get_psa_key_type_list "ECC") \
2827 $loc_curve_list"
2828
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002829 # Configure
2830 # ---------
2831
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002832 # Start with config crypto_full and remove PK_C:
2833 # that's what's supported now, see docs/driver-only-builds.md.
2834 helper_libtestdriver1_adjust_config "crypto_full"
2835 scripts/config.py unset MBEDTLS_PK_C
2836 scripts/config.py unset MBEDTLS_PK_PARSE_C
2837 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002838
2839 # Disable modules that are accelerated - some will be re-enabled
2840 scripts/config.py unset MBEDTLS_ECDSA_C
2841 scripts/config.py unset MBEDTLS_ECDH_C
2842 scripts/config.py unset MBEDTLS_ECJPAKE_C
2843 scripts/config.py unset MBEDTLS_ECP_C
2844
2845 # Disable all curves - those that aren't accelerated should be re-enabled
2846 helper_disable_builtin_curves
2847
2848 # Restartable feature is not yet supported by PSA. Once it will in
2849 # the future, the following line could be removed (see issues
2850 # 6061, 6332 and following ones)
2851 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2852
2853 # this is not supported by the driver API yet
2854 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2855
2856 # Build
2857 # -----
2858
2859 # These hashes are needed for some ECDSA signature tests.
2860 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2861 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2862 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2863
Valerio Settiac7a8092023-10-31 12:23:44 +01002864 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002865
2866 # We expect ECDH to be re-enabled for the missing curves
2867 grep mbedtls_ecdh_ library/ecdh.o
2868 # We expect ECP to be re-enabled, however the parts specific to the
2869 # families of curves that are accelerated should be ommited.
2870 # - functions with mxz in the name are specific to Montgomery curves
2871 # - ecp_muladd is specific to Weierstrass curves
2872 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002873 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002874 not grep mbedtls_ecp_muladd library/ecp.o
2875 grep mxz library/ecp.o
2876 else
2877 grep mbedtls_ecp_muladd library/ecp.o
2878 not grep mxz library/ecp.o
2879 fi
2880 # We expect ECDSA and ECJPAKE to be re-enabled only when
2881 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002882 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002883 not grep mbedtls_ecdsa library/ecdsa.o
2884 not grep mbedtls_ecjpake library/ecjpake.o
2885 else
2886 grep mbedtls_ecdsa library/ecdsa.o
2887 grep mbedtls_ecjpake library/ecjpake.o
2888 fi
2889
2890 # Run the tests
2891 # -------------
2892
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002893 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2894 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002895}
2896
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002897component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002898 common_test_psa_crypto_config_accel_ecc_some_curves 1
2899}
2900
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002901component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002902 common_test_psa_crypto_config_accel_ecc_some_curves 0
2903}
2904
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002905# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2906# ECDH, ECDSA) with and without drivers.
2907# The input parameter is a boolean value which indicates:
2908# - 0 keep built-in EC algs,
2909# - 1 exclude built-in EC algs (driver only).
2910#
2911# This is used by the two following components to ensure they always use the
2912# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002913# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2914# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002915# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002916config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002917 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002918 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002919 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002920 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002921 # Disable modules that are accelerated
2922 scripts/config.py unset MBEDTLS_ECDSA_C
2923 scripts/config.py unset MBEDTLS_ECDH_C
2924 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002925 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002926 fi
2927
2928 # Restartable feature is not yet supported by PSA. Once it will in
2929 # the future, the following line could be removed (see issues
2930 # 6061, 6332 and following ones)
2931 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002932}
2933
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002934# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2935component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002936 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002937
2938 # Algorithms and key types to accelerate
2939 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2940 ALG_ECDH \
2941 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002942 $(helper_get_psa_key_type_list "ECC") \
2943 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002944
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002945 # Configure
2946 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002947
2948 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002949 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002950
Valerio Setti0a342c92023-09-01 09:12:31 +02002951 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002952 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2953 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002954
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002955 # Build
2956 # -----
2957
2958 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002959 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2960 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002961 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2962
Valerio Setti3fe105b2023-10-30 11:08:12 +01002963 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002964
2965 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2966 not grep mbedtls_ecdsa_ library/ecdsa.o
2967 not grep mbedtls_ecdh_ library/ecdh.o
2968 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002969 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002970
2971 # Run the tests
2972 # -------------
2973
Gilles Peskine14302ed2023-07-19 19:30:04 +02002974 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002975 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002976
Gilles Peskine14302ed2023-07-19 19:30:04 +02002977 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002978 tests/ssl-opt.sh
2979}
2980
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002981# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2982component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002983 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002984
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002985 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002986
Gilles Peskine21570cf2023-12-22 11:49:50 +01002987 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002988
Gilles Peskine14302ed2023-07-19 19:30:04 +02002989 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002990 make test
2991
Gilles Peskine14302ed2023-07-19 19:30:04 +02002992 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002993 tests/ssl-opt.sh
2994}
2995
Valerio Settie618cb02023-04-12 14:59:16 +02002996# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002997# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2998# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002999# to ensure that both tests use the same underlying configuration when testing
3000# driver's coverage with analyze_outcomes.py.
3001#
3002# This functions accepts 1 boolean parameter as follows:
3003# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3004# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3005# - 0: include built-in implementation of EC algorithms.
3006#
3007# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3008# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003009config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003010 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003011 # start with full config for maximum coverage (also enables USE_PSA)
3012 helper_libtestdriver1_adjust_config "full"
3013
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003014 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003015 # Disable modules that are accelerated
3016 scripts/config.py unset MBEDTLS_ECDSA_C
3017 scripts/config.py unset MBEDTLS_ECDH_C
3018 scripts/config.py unset MBEDTLS_ECJPAKE_C
3019 # Disable ECP module (entirely)
3020 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003021 fi
3022
Valerio Settiaecd32c2023-06-14 10:42:31 +02003023 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3024 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003025 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003026 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003027
Valerio Settie618cb02023-04-12 14:59:16 +02003028 # Restartable feature is not yet supported by PSA. Once it will in
3029 # the future, the following line could be removed (see issues
3030 # 6061, 6332 and following ones)
3031 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003032}
3033
3034# Build and test a configuration where driver accelerates all EC algs while
3035# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3036# side.
3037#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003038# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3039component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003040 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003041
3042 # Algorithms and key types to accelerate
3043 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3044 ALG_ECDH \
3045 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003046 $(helper_get_psa_key_type_list "ECC") \
3047 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003048
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003049 # Configure
3050 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003051
Valerio Settie618cb02023-04-12 14:59:16 +02003052 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003053 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003054 # Disable all the builtin curves. All the required algs are accelerated.
3055 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003056
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003057 # Build
3058 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003059
3060 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003061 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3062 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3063 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003064
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003065 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003066
Valerio Setti3fe105b2023-10-30 11:08:12 +01003067 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003068
3069 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3070 not grep mbedtls_ecdsa_ library/ecdsa.o
3071 not grep mbedtls_ecdh_ library/ecdh.o
3072 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003073 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003074 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003075
3076 # Run the tests
3077 # -------------
3078
Gilles Peskine14302ed2023-07-19 19:30:04 +02003079 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003080 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003081
Gilles Peskine14302ed2023-07-19 19:30:04 +02003082 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003083 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003084}
3085
3086# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003087# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003088# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003089component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003090 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003091
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003092 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003093
Gilles Peskine21570cf2023-12-22 11:49:50 +01003094 make
Valerio Settie618cb02023-04-12 14:59:16 +02003095
Gilles Peskine14302ed2023-07-19 19:30:04 +02003096 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003097 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003098
Gilles Peskine14302ed2023-07-19 19:30:04 +02003099 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003100 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003101}
3102
Valerio Setti4e2f2442023-08-15 10:10:26 +02003103# This is a common configuration helper used directly from:
3104# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3105# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3106# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003107# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003108# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003109# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003110# - this is the reference component of the above
3111# - it still disables RSA and FFDH, but it uses builtin EC algs
3112# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3113# - accelerate all EC and FFDH algs, disable only RSA
3114# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3115# - this is the reference component of the above
3116# - it still disables RSA, but it uses builtin EC and FFDH algs
3117#
3118# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003119# $1: a boolean value which states if we are testing an accelerated scenario
3120# or not.
3121# $2: a string value which states which components are tested. Allowed values
3122# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003123config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003124 driver_only="$1"
3125 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003126 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003127 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003128
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003129 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003130 # Disable modules that are accelerated
3131 scripts/config.py unset MBEDTLS_ECDSA_C
3132 scripts/config.py unset MBEDTLS_ECDH_C
3133 scripts/config.py unset MBEDTLS_ECJPAKE_C
3134 # Disable ECP module (entirely)
3135 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003136 # Also disable bignum
3137 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003138 fi
3139
3140 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3141 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3142 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3143 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3144
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003145 # RSA support is intentionally disabled on this test because RSA_C depends
3146 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003147 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3148 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 +02003149 scripts/config.py unset MBEDTLS_RSA_C
3150 scripts/config.py unset MBEDTLS_PKCS1_V15
3151 scripts/config.py unset MBEDTLS_PKCS1_V21
3152 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3153 # Also disable key exchanges that depend on RSA
3154 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3155 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3156 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3157 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3158 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3159
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003160 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003161 # When testing ECC only, we disable FFDH support, both from builtin and
3162 # PSA sides, and also disable the key exchanges that depend on DHM.
3163 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3164 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 +01003165 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003166 scripts/config.py unset MBEDTLS_DHM_C
3167 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3168 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3169 else
3170 # When testing ECC and DH instead, we disable DHM and depending key
3171 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003172 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003173 scripts/config.py unset MBEDTLS_DHM_C
3174 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3175 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3176 fi
3177 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003178
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003179 # Restartable feature is not yet supported by PSA. Once it will in
3180 # the future, the following line could be removed (see issues
3181 # 6061, 6332 and following ones)
3182 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3183}
3184
Valerio Setti4e2f2442023-08-15 10:10:26 +02003185# Common helper used by:
3186# - component_test_psa_crypto_config_accel_ecc_no_bignum
3187# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003188#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003189# The goal is to build and test accelerating either:
3190# - ECC only or
3191# - both ECC and FFDH
3192#
3193# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003194# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3195# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003196common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003197 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003198
Valerio Setti5dfaca42023-09-05 08:48:51 +02003199 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003200 if [ "$test_target" = "ECC_DH" ]; then
3201 accel_text="ECC/FFDH"
3202 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003203 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003204 accel_text="ECC"
3205 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003206 fi
3207
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003208 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003209
3210 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003211 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3212 ALG_ECDH \
3213 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003214 $(helper_get_psa_key_type_list "ECC") \
3215 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003216 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003217 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003218 loc_accel_list="$loc_accel_list \
3219 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003220 $(helper_get_psa_key_type_list "DH") \
3221 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003222 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003223
3224 # Configure
3225 # ---------
3226
3227 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003228 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003229 # Disable all the builtin curves. All the required algs are accelerated.
3230 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003231
3232 # Build
3233 # -----
3234
3235 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003236 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3237 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3238 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003239
3240 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3241
Valerio Setti3fe105b2023-10-30 11:08:12 +01003242 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003243
3244 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3245 not grep mbedtls_ecdsa_ library/ecdsa.o
3246 not grep mbedtls_ecdh_ library/ecdh.o
3247 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003248 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003249 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003250 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003251 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003252 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003253
3254 # Run the tests
3255 # -------------
3256
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003257 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003258
Gilles Peskine21570cf2023-12-22 11:49:50 +01003259 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003260
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003261 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003262 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003263}
3264
Valerio Setti4e2f2442023-08-15 10:10:26 +02003265# Common helper used by:
3266# - component_test_psa_crypto_config_reference_ecc_no_bignum
3267# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3268#
3269# The goal is to build and test a reference scenario (i.e. with builtin
3270# components) compared to the ones used in
3271# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3272#
3273# It is meant to be used in conjunction with
3274# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3275# coverage analysis in "analyze_outcomes.py" script.
3276common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003277 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003278
Valerio Setti5dfaca42023-09-05 08:48:51 +02003279 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003280 if [ "$test_target" = "ECC_DH" ]; then
3281 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003282 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003283 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003284 fi
3285
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003286 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003287
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003288 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003289
Gilles Peskine21570cf2023-12-22 11:49:50 +01003290 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003291
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003292 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003293 make test
3294
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003295 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003296 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003297}
3298
Valerio Setti4e2f2442023-08-15 10:10:26 +02003299component_test_psa_crypto_config_accel_ecc_no_bignum () {
3300 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3301}
3302
3303component_test_psa_crypto_config_reference_ecc_no_bignum () {
3304 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3305}
3306
3307component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3308 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3309}
3310
3311component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3312 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3313}
3314
Valerio Settiac6d35f2023-08-04 12:49:11 +02003315# Helper for setting common configurations between:
3316# - component_test_tfm_config_p256m_driver_accel_ec()
3317# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003318common_tfm_config () {
3319 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003320 cp configs/config-tfm.h "$CONFIG_H"
3321 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3322 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003323
Yanray Wang73bb2312023-09-25 11:21:15 +08003324 # Other config adjustment to make the tests pass.
3325 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003326 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003327 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3328 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003329
Yanray Wang73bb2312023-09-25 11:21:15 +08003330 # Config adjustment for better test coverage in our environment.
3331 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003332 #
3333 # Enable filesystem I/O for the benefit of PK parse/write tests.
3334 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3335}
3336
Valerio Settiac6d35f2023-08-04 12:49:11 +02003337# Keep this in sync with component_test_tfm_config() as they are both meant
3338# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003339component_test_tfm_config_p256m_driver_accel_ec () {
3340 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3341
3342 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003343
Dave Rodgman897bb772023-11-15 16:34:20 +00003344 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003345 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003346
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003347 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3348 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003349 not grep mbedtls_ecdh_ library/ecdh.o
3350 not grep mbedtls_ecjpake_ library/ecjpake.o
3351 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3352 not grep mbedtls_ecp_ library/ecp.o
3353 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003354 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003355 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003356 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003357 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003358
Valerio Setti5e18b902023-12-04 12:07:30 +01003359 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3360 # files, so we want to ensure that it has not be re-enabled accidentally.
3361 not grep mbedtls_cipher library/cipher.o
3362
Valerio Settib7e95442023-03-21 11:52:33 +01003363 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003364 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003365 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003366}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003367
Valerio Settiac6d35f2023-08-04 12:49:11 +02003368# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3369# they are both meant to be used in analyze_outcomes.py for driver's coverage
3370# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003371component_test_tfm_config() {
3372 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003373
Dave Rodgman897bb772023-11-15 16:34:20 +00003374 # Disable P256M driver, which is on by default, so that analyze_outcomes
3375 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3376 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3377
Valerio Setti52ba0e32023-08-04 12:43:03 +02003378 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003379 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003380
Dave Rodgman897bb772023-11-15 16:34:20 +00003381 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003382 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003383
Valerio Setti5e18b902023-12-04 12:07:30 +01003384 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3385 # files, so we want to ensure that it has not be re-enabled accidentally.
3386 not grep mbedtls_cipher library/cipher.o
3387
Valerio Setti52ba0e32023-08-04 12:43:03 +02003388 msg "test: TF-M config"
3389 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003390}
3391
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003392# Common helper for component_full_without_ecdhe_ecdsa() and
3393# component_full_without_ecdhe_ecdsa_and_tls13() which:
3394# - starts from the "full" configuration minus the list of symbols passed in
3395# as 1st parameter
3396# - build
3397# - test only TLS (i.e. test_suite_tls and ssl-opt)
3398build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003399 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003400
3401 msg "build: full minus something, test TLS"
3402
3403 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003404 for sym in $symbols_to_disable; do
3405 echo "Disabling $sym"
3406 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003407 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003408
Gilles Peskine21570cf2023-12-22 11:49:50 +01003409 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003410
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003411 msg "test: full minus something, test TLS"
3412 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003413
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003414 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003415 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003416}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003417
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003418component_full_without_ecdhe_ecdsa () {
3419 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003420}
3421
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003422component_full_without_ecdhe_ecdsa_and_tls13 () {
3423 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3424 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003425}
3426
Valerio Setti249b18a2023-06-20 12:08:30 +02003427# This is an helper used by:
3428# - component_test_psa_ecc_key_pair_no_derive
3429# - component_test_psa_ecc_key_pair_no_generate
3430# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3431# enabled, but one. Input arguments are as follows:
3432# - $1 is the key type under test, i.e. ECC/RSA/DH
3433# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003434build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003435 key_type=$1
3436 unset_option=$2
3437 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003438
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003439 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003440 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003441 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3442 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3443
3444 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3445 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003446 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003447
Gilles Peskine21570cf2023-12-22 11:49:50 +01003448 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003449
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003450 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003451 make test
3452}
3453
3454component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003455 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003456}
3457
3458component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003459 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003460}
3461
Pengyu Lve705f572023-12-06 16:38:15 +08003462config_psa_crypto_accel_rsa () {
3463 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003464
Pengyu Lve705f572023-12-06 16:38:15 +08003465 # Start from crypto_full config (no X.509, no TLS)
3466 helper_libtestdriver1_adjust_config "crypto_full"
3467
3468 if [ "$driver_only" -eq 1 ]; then
3469 # Remove RSA support and its dependencies
3470 scripts/config.py unset MBEDTLS_RSA_C
3471 scripts/config.py unset MBEDTLS_PKCS1_V15
3472 scripts/config.py unset MBEDTLS_PKCS1_V21
3473
3474 # We need PEM parsing in the test library as well to support the import
3475 # of PEM encoded RSA keys.
3476 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3477 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3478 fi
3479}
3480
3481component_test_psa_crypto_config_accel_rsa_crypto () {
3482 msg "build: crypto_full with accelerated RSA"
3483
3484 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3485 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3486 KEY_TYPE_RSA_PUBLIC_KEY \
3487 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3488 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3489 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3490 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003491
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003492 # Configure
3493 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003494
Pengyu Lve705f572023-12-06 16:38:15 +08003495 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003496
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003497 # Build
3498 # -----
3499
Pengyu Lve705f572023-12-06 16:38:15 +08003500 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003501 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 +08003502 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003503 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003504
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003505 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003506
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003507 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003508 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003509
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003510 # Run the tests
3511 # -------------
3512
Pengyu Lve705f572023-12-06 16:38:15 +08003513 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003514 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003515}
3516
3517component_test_psa_crypto_config_reference_rsa_crypto () {
3518 msg "build: crypto_full with non-accelerated RSA"
3519
3520 # Configure
3521 # ---------
3522 config_psa_crypto_accel_rsa 0
3523
3524 # Build
3525 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003526 make
Pengyu Lve705f572023-12-06 16:38:15 +08003527
3528 # Run the tests
3529 # -------------
3530 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003531 make test
3532}
3533
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003534# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003535# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003536component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003537 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003538
Valerio Setti4590bc22023-06-13 15:39:23 +02003539 # Create a temporary output file unless there is already one set
3540 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3541 REMOVE_OUTCOME_ON_EXIT="no"
3542 else
3543 REMOVE_OUTCOME_ON_EXIT="yes"
3544 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3545 export MBEDTLS_TEST_OUTCOME_FILE
3546 fi
3547
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003548 # Start from crypto configuration
3549 scripts/config.py crypto
3550
3551 # Remove RSA support and its dependencies
3552 scripts/config.py unset MBEDTLS_PKCS1_V15
3553 scripts/config.py unset MBEDTLS_PKCS1_V21
3554 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3555 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3556 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3557 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3558 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3559 scripts/config.py unset MBEDTLS_RSA_C
3560 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3561
3562 # Enable PSA support
3563 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3564
Valerio Setti01cc88a2023-06-15 11:53:08 +02003565 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003566 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003567 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3568 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3569 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003570
3571 make
3572
Valerio Setti01cc88a2023-06-15 11:53:08 +02003573 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003574 make test
3575
3576 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3577 # performing RSA signature.
3578 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3579 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3580
3581 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3582 rm $MBEDTLS_TEST_OUTCOME_FILE
3583 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003584}
3585
Ronald Cronb2312452021-05-08 14:32:59 +02003586component_test_psa_crypto_config_accel_hash () {
3587 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3588
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003589 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3590 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3591 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003592
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003593 # Configure
3594 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003595
3596 # Start from default config (no TLS 1.3, no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003597 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003598
3599 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003600 scripts/config.py unset MBEDTLS_MD5_C
3601 scripts/config.py unset MBEDTLS_RIPEMD160_C
3602 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003603 scripts/config.py unset MBEDTLS_SHA224_C
3604 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003605 scripts/config.py unset MBEDTLS_SHA384_C
3606 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003607 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003608
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003609 # Build
3610 # -----
3611
3612 helper_libtestdriver1_make_drivers "$loc_accel_list"
3613
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003614 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003615
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003616 # There's a risk of something getting re-enabled via config_psa.h;
3617 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3618 not grep mbedtls_md5 library/md5.o
3619 not grep mbedtls_sha1 library/sha1.o
3620 not grep mbedtls_sha256 library/sha256.o
3621 not grep mbedtls_sha512 library/sha512.o
3622 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003623
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003624 # Run the tests
3625 # -------------
3626
Ronald Cronb2312452021-05-08 14:32:59 +02003627 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3628 make test
3629}
3630
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003631component_test_psa_crypto_config_accel_hash_keep_builtins () {
3632 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3633 # This component ensures that all the test cases for
3634 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3635
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003636 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3637 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3638 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003639
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003640 # Start from default config (no TLS 1.3, no USE_PSA)
3641 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003642
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003643 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003644
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003645 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003646
3647 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3648 make test
3649}
3650
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003651# Auxiliary function to build config for hashes with and without drivers
3652config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003653 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003654 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003655 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003656 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003657 # disable the built-in implementation of hashes
3658 scripts/config.py unset MBEDTLS_MD5_C
3659 scripts/config.py unset MBEDTLS_RIPEMD160_C
3660 scripts/config.py unset MBEDTLS_SHA1_C
3661 scripts/config.py unset MBEDTLS_SHA224_C
3662 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003663 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003664 scripts/config.py unset MBEDTLS_SHA384_C
3665 scripts/config.py unset MBEDTLS_SHA512_C
3666 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003667 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003668 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003669}
3670
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003671# Note that component_test_psa_crypto_config_reference_hash_use_psa
3672# is related to this component and both components need to be kept in sync.
3673# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003674component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003675 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003676
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003677 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3678 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3679 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003680
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003681 # Configure
3682 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003683
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003684 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +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"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003692
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003693 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003694 # 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 +02003695 not grep mbedtls_md5 library/md5.o
3696 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003697 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003698 not grep mbedtls_sha512 library/sha512.o
3699 not grep mbedtls_ripemd160 library/ripemd160.o
3700
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003701 # Run the tests
3702 # -------------
3703
Gilles Peskine14302ed2023-07-19 19:30:04 +02003704 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003705 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003706
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003707 # This is mostly useful so that we can later compare outcome files with
3708 # the reference config in analyze_outcomes.py, to check that the
3709 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003710 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003711 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003712
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003713 # This is to make sure all ciphersuites are exercised, but we don't need
3714 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003715 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003716 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003717}
3718
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003719# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3720# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3721# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3722# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003723component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003724 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003725
3726 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003727
Gilles Peskine21570cf2023-12-22 11:49:50 +01003728 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003729
Gilles Peskine14302ed2023-07-19 19:30:04 +02003730 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003731 make test
3732
Gilles Peskine14302ed2023-07-19 19:30:04 +02003733 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003734 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003735}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003736
Valerio Setti8eb310c2024-01-22 16:22:57 +01003737# Auxiliary function to build config for hashes with and without drivers
3738config_psa_crypto_hmac_use_psa () {
3739 driver_only="$1"
3740 # start with config full for maximum coverage (also enables USE_PSA)
3741 helper_libtestdriver1_adjust_config "full"
3742
Valerio Setticd89b0b2024-01-24 14:24:55 +01003743 if [ "$driver_only" -eq 1 ]; then
3744 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3745 # is still enabled though (for ENTROPY_C among others).
3746 scripts/config.py unset MBEDTLS_MD_C
3747 # Disable also the builtin hashes since they are supported by the driver
3748 # and MD module is able to perform PSA dispathing.
3749 scripts/config.py unset-all MBEDTLS_SHA
3750 scripts/config.py unset MBEDTLS_MD5_C
3751 scripts/config.py unset MBEDTLS_RIPEMD160_C
3752 fi
3753
Valerio Setti8eb310c2024-01-22 16:22:57 +01003754 # Direct dependencies of MD_C. We disable them also in the reference
3755 # component to work with the same set of features.
3756 scripts/config.py unset MBEDTLS_PKCS7_C
3757 scripts/config.py unset MBEDTLS_PKCS5_C
3758 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3759 scripts/config.py unset MBEDTLS_HKDF_C
3760 # Dependencies of HMAC_DRBG
3761 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3762 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3763}
3764
3765component_test_psa_crypto_config_accel_hmac() {
3766 msg "test: full with accelerated hmac"
3767
3768 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3769 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3770 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3771 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3772
3773 # Configure
3774 # ---------
3775
3776 config_psa_crypto_hmac_use_psa 1
3777
Valerio Setti8eb310c2024-01-22 16:22:57 +01003778 # Build
3779 # -----
3780
3781 helper_libtestdriver1_make_drivers "$loc_accel_list"
3782
3783 helper_libtestdriver1_make_main "$loc_accel_list"
3784
3785 # Ensure that built-in support for HMAC is disabled.
3786 not grep mbedtls_md_hmac library/md.o
3787
3788 # Run the tests
3789 # -------------
3790
3791 msg "test: full with accelerated hmac"
3792 make test
3793}
3794
3795component_test_psa_crypto_config_reference_hmac() {
3796 msg "test: full without accelerated hmac"
3797
3798 config_psa_crypto_hmac_use_psa 0
3799
3800 make
3801
3802 msg "test: full without accelerated hmac"
3803 make test
3804}
3805
Valerio Setti9da01a72023-12-18 17:38:18 +01003806component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003807 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003808
Valerio Setti9da01a72023-12-18 17:38:18 +01003809 # Albeit this components aims at accelerating DES which should only support
3810 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3811 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003812 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3813 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3814 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003815
Valerio Setti9da01a72023-12-18 17:38:18 +01003816 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3817 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3818 # of this component. This limitation will be addressed by #8598.
3819
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003820 # Configure
3821 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003822
Valerio Setti9a427302023-10-17 11:40:42 +02003823 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003824 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003825
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003826 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003827 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3828 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3829 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3830 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3831 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3832 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3833 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003834 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003835
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003836 # Build
3837 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003838
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003839 helper_libtestdriver1_make_drivers "$loc_accel_list"
3840
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003841 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003842
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003843 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003844 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003845
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003846 # Run the tests
3847 # -------------
3848
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003849 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003850 make test
3851}
3852
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003853component_test_psa_crypto_config_accel_aead () {
3854 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3855
Valerio Setti3f02bb72023-10-02 15:57:33 +02003856 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3857 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003858
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003859 # Configure
3860 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003861
Valerio Setti3f02bb72023-10-02 15:57:33 +02003862 # Start from full config
3863 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003864
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003865 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003866 scripts/config.py unset MBEDTLS_GCM_C
3867 scripts/config.py unset MBEDTLS_CCM_C
3868 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003869
Valerio Settia50b89e2023-11-08 15:58:47 +01003870 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3871 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003872
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003873 # Build
3874 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003875
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003876 helper_libtestdriver1_make_drivers "$loc_accel_list"
3877
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003878 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003879
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003880 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003881 not grep mbedtls_ccm library/ccm.o
3882 not grep mbedtls_gcm library/gcm.o
3883 not grep mbedtls_chachapoly library/chachapoly.o
3884
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003885 # Run the tests
3886 # -------------
3887
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003888 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3889 make test
3890}
3891
Valerio Settib680fc42023-10-13 09:29:37 +02003892# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003893# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3894# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3895common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003896 # Start from the full config
3897 helper_libtestdriver1_adjust_config "full"
3898
Valerio Settib680fc42023-10-13 09:29:37 +02003899 scripts/config.py unset MBEDTLS_NIST_KW_C
3900}
3901
Valerio Settib6b301f2023-10-04 12:05:05 +02003902# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003903# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3904# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003905# are meant to be used together in analyze_outcomes.py script in order to test
3906# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003907component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3908 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003909
Valerio Settiad8b7f02023-10-25 12:39:50 +02003910 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 +01003911 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003912 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003913 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3914
3915 # Configure
3916 # ---------
3917
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003918 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003919
3920 # Disable the things that are being accelerated
3921 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3922 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3923 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3924 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3925 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3926 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3927 scripts/config.py unset MBEDTLS_GCM_C
3928 scripts/config.py unset MBEDTLS_CCM_C
3929 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003930 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003931 scripts/config.py unset MBEDTLS_DES_C
3932 scripts/config.py unset MBEDTLS_AES_C
3933 scripts/config.py unset MBEDTLS_ARIA_C
3934 scripts/config.py unset MBEDTLS_CHACHA20_C
3935 scripts/config.py unset MBEDTLS_CAMELLIA_C
3936
Valerio Settiec9b2582023-11-08 16:50:54 +01003937 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3938 # does not depend on it.
3939 scripts/config.py unset MBEDTLS_CIPHER_C
3940
Valerio Settib6b301f2023-10-04 12:05:05 +02003941 # Build
3942 # -----
3943
3944 helper_libtestdriver1_make_drivers "$loc_accel_list"
3945
3946 helper_libtestdriver1_make_main "$loc_accel_list"
3947
3948 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003949 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003950 not grep mbedtls_des library/des.o
3951 not grep mbedtls_aes library/aes.o
3952 not grep mbedtls_aria library/aria.o
3953 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003954 not grep mbedtls_ccm library/ccm.o
3955 not grep mbedtls_gcm library/gcm.o
3956 not grep mbedtls_chachapoly library/chachapoly.o
3957 not grep mbedtls_cmac library/cmac.o
3958
3959 # Run the tests
3960 # -------------
3961
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003962 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003963 make test
Valerio Settif9414552023-11-09 10:43:20 +01003964
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003965 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003966 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003967
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003968 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003969 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003970}
3971
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003972component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3973 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3974 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003975
Gilles Peskine21570cf2023-12-22 11:49:50 +01003976 make
Valerio Settif9414552023-11-09 10:43:20 +01003977
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003978 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003979 make test
Valerio Settif9414552023-11-09 10:43:20 +01003980
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003981 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003982 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003983
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003984 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003985 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003986}
3987
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003988common_block_cipher_dispatch() {
3989 TEST_WITH_DRIVER="$1"
3990
3991 # Start from the full config
3992 helper_libtestdriver1_adjust_config "full"
3993
3994 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3995 # Disable key types that are accelerated (there is no legacy equivalent
3996 # symbol for ECB)
3997 scripts/config.py unset MBEDTLS_AES_C
3998 scripts/config.py unset MBEDTLS_ARIA_C
3999 scripts/config.py unset MBEDTLS_CAMELLIA_C
4000 fi
4001
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004002 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004003 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004004 # Keep this also in the reference component in order to skip the same tests
4005 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004006 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4007 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4008 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4009 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4010 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4011 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4012 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004013
4014 # Disable direct dependency on AES_C
4015 scripts/config.py unset MBEDTLS_NIST_KW_C
4016
4017 # Prevent the cipher module from using deprecated PSA path. The reason is
4018 # that otherwise there will be tests relying on "aes_info" (defined in
4019 # "cipher_wrap.c") whose functions are not available when AES_C is
4020 # not defined. ARIA and Camellia are not a problem in this case because
4021 # the PSA path is not tested for these key types.
4022 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4023}
4024
Valerio Settif8e6cba2023-12-12 11:53:39 +01004025component_test_full_block_cipher_psa_dispatch () {
4026 msg "build: full + PSA dispatch in block_cipher"
4027
4028 loc_accel_list="ALG_ECB_NO_PADDING \
4029 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4030
4031 # Configure
4032 # ---------
4033
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004034 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004035
Valerio Settif8e6cba2023-12-12 11:53:39 +01004036 # Build
4037 # -----
4038
4039 helper_libtestdriver1_make_drivers "$loc_accel_list"
4040
4041 helper_libtestdriver1_make_main "$loc_accel_list"
4042
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004043 # Make sure disabled components were not re-enabled by accident (additive
4044 # config)
4045 not grep mbedtls_aes_ library/aes.o
4046 not grep mbedtls_aria_ library/aria.o
4047 not grep mbedtls_camellia_ library/camellia.o
4048
Valerio Settif8e6cba2023-12-12 11:53:39 +01004049 # Run the tests
4050 # -------------
4051
4052 msg "test: full + PSA dispatch in block_cipher"
4053 make test
4054}
4055
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004056# This is the reference component of component_test_full_block_cipher_psa_dispatch
4057component_test_full_block_cipher_legacy_dispatch () {
4058 msg "build: full + legacy dispatch in block_cipher"
4059
4060 common_block_cipher_dispatch 0
4061
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004062 make
4063
4064 msg "test: full + legacy dispatch in block_cipher"
4065 make test
4066}
4067
Gilles Peskine36dea152023-07-20 22:19:45 +02004068component_test_aead_chachapoly_disabled() {
4069 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004070 scripts/config.py full
4071 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004072 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004073 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004074
Gilles Peskine36dea152023-07-20 22:19:45 +02004075 msg "test: full minus CHACHAPOLY"
4076 make test
4077}
4078
4079component_test_aead_only_ccm() {
4080 msg "build: full minus CHACHAPOLY and GCM"
4081 scripts/config.py full
4082 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4083 scripts/config.py unset MBEDTLS_GCM_C
4084 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4085 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004086 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004087
4088 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004089 make test
4090}
4091
Ronald Crone501d0e2023-07-10 08:31:19 +02004092component_test_ccm_aes_sha256() {
4093 msg "build: CCM + AES + SHA256 configuration"
4094
Ronald Cron7612d8c2023-07-20 10:03:54 +02004095 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004096 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004097
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004098 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004099
4100 msg "test: CCM + AES + SHA256 configuration"
4101 make test
4102}
4103
John Durkopd0321952020-10-29 21:37:36 -07004104# 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 -08004105component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004106 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004107 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004108 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004109 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004110 scripts/config.py unset MBEDTLS_ECDH_C
4111 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4112 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4113 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4114 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4115 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4116 # 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 +01004117 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 -07004118}
4119
4120# 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 -08004121component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004122 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004123 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004124 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004125 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004126 # 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 +01004127 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 -07004128}
4129
4130# 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 -08004131component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004132 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004133 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004134 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004135 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004136 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004137 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4138 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004139 # 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 +01004140 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 -07004141}
4142
John Durkop1b7ee052020-11-27 08:51:22 -08004143# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4144component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004145 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004146 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004147 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004148 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004149 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4150 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4151 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4152 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4153 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4154 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4155 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004156 scripts/config.py unset MBEDTLS_LMS_C
4157 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004158 # 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 +01004159 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 -08004160}
4161
4162# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4163component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004164 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004165 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004166 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004167 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004168 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4169 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4170 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4171 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4172 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4173 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4174 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004175 scripts/config.py unset MBEDTLS_LMS_C
4176 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004177 # 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 +01004178 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 -08004179}
4180
4181# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4182component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004183 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004184 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004185 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
Ronald Cron6b49b552023-07-20 09:57:54 +02004187 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4188 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4189 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4190 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4191 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4192 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4193 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004194 scripts/config.py unset MBEDTLS_LMS_C
4195 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004196 # 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 +01004197 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 -08004198}
4199
4200# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4201component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004202 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004203 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004204 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004205 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004206 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4207 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4208 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4209 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4210 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4211 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004212 # 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 +01004213 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 -08004214}
4215
4216# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4217component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004218 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004219 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004220 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004221 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004222 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4223 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4224 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4225 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4226 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4227 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004228 # 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 +01004229 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 -08004230}
4231
4232# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4233component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004234 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004235 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004236 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004237 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004238 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4239 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4240 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4241 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4242 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4243 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004244 scripts/config.py unset MBEDTLS_LMS_C
4245 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004246 # 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 +01004247 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 -08004248}
4249
4250# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4251component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004252 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004253 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004254 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004255 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004256 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4257 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4258 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4259 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4260 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4261 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4262 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004263 scripts/config.py unset MBEDTLS_LMS_C
4264 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004265 # 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 +01004266 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 -08004267}
4268
John Durkopd0321952020-10-29 21:37:36 -07004269# 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 -08004270component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004271 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 -07004272 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004273 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004274 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004275 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4276 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4277 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4278 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004279 # 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 +01004280 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 -07004281}
4282
4283# 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 -08004284component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004285 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 -07004286 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004287 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004288 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004289 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4290 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4291 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4292 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004293 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004294 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004295}
4296
4297# 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 -08004298component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004299 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 -07004300 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004301 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004302 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004303 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4304 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4305 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4306 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004307 # 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 +01004308 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 -07004309}
4310
4311# 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 -08004312component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004313 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 -07004314 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004315 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004316 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004317 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4318 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4319 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4320 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004321 # 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 +01004322 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 -07004323}
4324
4325# 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 -08004326component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004327 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 -07004328 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004329 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004330 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004331 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4332 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4333 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4334 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4335 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004336 # 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 +01004337 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 -07004338}
4339
4340# 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 -08004341component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004342 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 -07004343 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004344 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004345 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004346 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4347 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004348 # 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 +01004349 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 -07004350}
4351
Dave Rodgmanc164c072023-06-28 09:43:23 +01004352
Dave Rodgman904c5892023-06-28 17:36:02 +01004353support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004354 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004355}
4356
Dave Rodgman904c5892023-06-28 17:36:02 +01004357component_build_tfm_armcc() {
4358 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004359 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004360
Dave Rodgman88651c42023-06-29 12:35:51 +01004361 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004362 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 +01004363}
4364
4365component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004366 # Check that the TF-M configuration can build cleanly with various
4367 # warning flags enabled. We don't build or run tests, since the
4368 # TF-M configuration needs a TF-M platform. A tweaked version of
4369 # the configuration that works on mainstream platforms is in
4370 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004371 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004372
Dave Rodgman88651c42023-06-29 12:35:51 +01004373 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004374 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 +01004375
Dave Rodgman904c5892023-06-28 17:36:02 +01004376 msg "build: TF-M config, gcc native build"
4377 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004378 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 +01004379}
4380
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004381# Test that the given .o file builds with all (valid) combinations of the given options.
4382#
4383# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4384#
4385# The validator function is the name of a function to validate the combination of options.
4386# It may be "" if all combinations are valid.
4387# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004388# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004389build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004390 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004391 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004392 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004393 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004394 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004395
Dave Rodgman42436102023-10-03 15:47:05 +01004396 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004397 for opt in "${options[@]}"; do
4398 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004399 done
4400
4401 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004402 cd $(dirname ${file})
4403 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004404
Dave Rodgman920343a2023-10-01 18:41:09 +01004405 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004406 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 +01004407
Dave Rodgman42436102023-10-03 15:47:05 +01004408 # Extract the command generated by the Makefile to build the target file.
4409 # This ensures that we have any include paths, macro definitions, etc
4410 # that may be applied by make.
4411 # 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 +01004412 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004413
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004414 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004415 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004416
Dave Rodgman28e38d82023-10-04 11:50:30 +01004417 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004418 source_file=${file%.o}.c
4419
4420 targets=0
4421 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004422
Dave Rodgman28e38d82023-10-04 11:50:30 +01004423 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004424 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004425 # each bit of $i is used to determine if options[i] will be set or not
4426 target="t"
4427 clang_args=""
4428 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004429 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004430 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004431 clang_args="${clang_args} ${opt}"
4432 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004433 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004434 done
4435
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004436 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004437 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004438 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004439 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004440
Dave Rodgman28e38d82023-10-04 11:50:30 +01004441 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004442 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004443 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004444 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004445
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004446 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004447
Dave Rodgman920343a2023-10-01 18:41:09 +01004448 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004449 make -s -f ${makefile} build_test_config_combos
4450 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004451
4452 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004453 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004454}
4455
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004456validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004457 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4458 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004459 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004460 fi
4461 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4462 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004463 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004464 fi
4465 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004466 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004467}
4468
4469component_build_aes_variations() {
4470 # 18s - around 90ms per clang invocation on M1 Pro
4471 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004472 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004473 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004474
Yanray Wangbc29aef2023-11-06 11:08:17 +08004475 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004476 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004477
Dave Rodgman42436102023-10-03 15:47:05 +01004478 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004479 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4480 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4481 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4482 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004483
4484 cd "$MBEDTLS_ROOT_DIR"
4485 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4486
Yanray Wang42be1ba2023-11-23 14:28:47 +08004487 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004488 # manually set or unset those configurations to check
4489 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004490 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4491 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4492 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4493 scripts/config.py unset MBEDTLS_DES_C
4494 scripts/config.py unset MBEDTLS_NIST_KW_C
4495 build_test_config_combos library/aes.o validate_aes_config_variations \
4496 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4497 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4498 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4499 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004500}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004501
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004502component_test_no_platform () {
4503 # Full configuration build, without platform support, file IO and net sockets.
4504 # This should catch missing mbedtls_printf definitions, and by disabling file
4505 # IO, it should catch missing '#include <stdio.h>'
4506 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004507 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004508 scripts/config.py unset MBEDTLS_PLATFORM_C
4509 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004510 scripts/config.py unset MBEDTLS_FS_IO
4511 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004512 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004513 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004514 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004515 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004516 # to re-enable platform integration features otherwise disabled in C99 builds
4517 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004518 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004519}
Gilles Peskine7c652162017-12-11 00:01:40 +01004520
4521component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004522 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004523 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4524 scripts/config.py full
4525 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004526 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4527 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4528 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4529 make
4530}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004531
Gilles Peskine8f073122018-11-27 15:58:47 +01004532component_build_no_ssl_srv () {
4533 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004534 scripts/config.py full
4535 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004536 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004537}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004538
Gilles Peskine8f073122018-11-27 15:58:47 +01004539component_build_no_ssl_cli () {
4540 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004541 scripts/config.py full
4542 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004543 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004544}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004545
Gilles Peskine8f073122018-11-27 15:58:47 +01004546component_build_no_sockets () {
4547 # Note, C99 compliance can also be tested with the sockets support disabled,
4548 # as that requires a POSIX platform (which isn't the same as C99).
4549 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004550 scripts/config.py full
4551 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4552 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4553 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4554}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004555
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004556component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004557 msg "build: default config with memory buffer allocator and backtrace enabled"
4558 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4559 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4560 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004561 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004562 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004563 make
4564
4565 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4566 make test
4567}
4568
4569component_test_memory_buffer_allocator () {
4570 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004571 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4572 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004573 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004574 make
4575
4576 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4577 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004578
4579 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4580 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004581 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004582}
4583
Gilles Peskine8f073122018-11-27 15:58:47 +01004584component_test_no_max_fragment_length () {
4585 # Run max fragment length tests with MFL disabled
4586 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004587 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004588 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004589 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004590
Gilles Peskine8f073122018-11-27 15:58:47 +01004591 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004592 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004593}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004594
Hanno Becker545ced42019-02-19 11:10:48 +00004595component_test_asan_remove_peer_certificate () {
4596 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004597 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Dave Rodgman17127e92023-12-14 16:42:48 +00004598 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004599 make
4600
4601 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4602 make test
4603
4604 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004605 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004606
4607 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004608 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004609
4610 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004611 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004612}
4613
Gilles Peskine8f073122018-11-27 15:58:47 +01004614component_test_no_max_fragment_length_small_ssl_out_content_len () {
4615 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004616 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4617 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4618 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004619 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004620 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004621
Gilles Peskine8f073122018-11-27 15:58:47 +01004622 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004623 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004624
4625 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004626 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004627}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004628
Darryl Greenaad82f92019-12-02 10:53:11 +00004629component_test_variable_ssl_in_out_buffer_len () {
4630 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4631 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004632 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004633 make
4634
4635 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4636 make test
4637
4638 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004639 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004640
4641 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004642 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004643}
4644
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004645component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004646 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004647 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004648
Dave Rodgman17127e92023-12-14 16:42:48 +00004649 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004650 make
4651
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004652 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004653 make test
4654
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004655 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004656 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004657
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004658 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004659 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004660}
4661
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004662component_test_ssl_alloc_buffer_and_mfl () {
4663 msg "build: default config with memory buffer allocator and MFL extension"
4664 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4665 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4666 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4667 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4668 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004669 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004670 make
4671
4672 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4673 make test
4674
4675 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 +02004676 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004677}
4678
Gilles Peskine636c26a2020-03-04 20:46:15 +01004679component_test_when_no_ciphersuites_have_mac () {
4680 msg "build: when no ciphersuites have MAC"
4681 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004682 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004683 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004684 make
4685
4686 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4687 make test
4688
4689 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004690 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004691}
4692
Raoul Strackxa4e86142020-06-15 17:03:13 +02004693component_test_no_date_time () {
4694 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4695 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004696 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004697 make
4698
4699 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4700 make test
4701}
4702
Gilles Peskine8f073122018-11-27 15:58:47 +01004703component_test_platform_calloc_macro () {
4704 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004705 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4706 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4707 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004708 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004709 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004710
Gilles Peskine8f073122018-11-27 15:58:47 +01004711 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4712 make test
4713}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004714
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004715component_test_malloc_0_null () {
4716 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004717 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004718 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 +02004719
4720 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4721 make test
4722
4723 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4724 # Just the calloc selftest. "make test" ran the others as part of the
4725 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004726 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004727
4728 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4729 # Run a subset of the tests. The choice is a balance between coverage
4730 # and time (including time indirectly wasted due to flaky tests).
4731 # The current choice is to skip tests whose description includes
4732 # "proxy", which is an approximation of skipping tests that use the
4733 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004734 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004735}
4736
Dave Rodgman6a08b682023-06-19 11:51:33 +01004737support_test_aesni() {
4738 # Check that gcc targets x86_64 (we can build AESNI), and check for
4739 # AESNI support on the host (we can run AESNI).
4740 #
4741 # The name of this function is possibly slightly misleading, but needs to align
4742 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004743 #
4744 # In principle 32-bit x86 can support AESNI, but our implementation does not
4745 # support 32-bit x86, so we check for x86-64.
4746 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004747 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4748 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004749 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004750}
4751
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004752component_test_aesni () { # ~ 60s
4753 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4754 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4755 #
4756 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4757 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4758 # exercise the plain C impl).
4759
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004760 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004761 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004762 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004763 scripts/config.py set MBEDTLS_HAVE_ASM
4764
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004765 # test the intrinsics implementation
4766 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004767 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004768 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004769 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004770 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004771
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004772 # test the asm implementation
4773 msg "AES tests, test assembly"
4774 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004775 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004776 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004777 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004778
4779 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004780 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004781 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004782 msg "AES tests, plain C"
4783 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004784 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004785 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004786 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004787 not grep -q "AES note: using AESNI" ./programs/test/selftest
4788 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004789
4790 # test the intrinsics implementation
4791 scripts/config.py set MBEDTLS_AESNI_C
4792 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4793 msg "AES tests, test AESNI only"
4794 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004795 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004796 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4797 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004798 grep -q "AES note: using AESNI" ./programs/test/selftest
4799 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004800}
4801
Jerry Yub6d39c22023-08-16 15:11:48 +08004802support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004803 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004804}
4805
4806component_test_aesni_m32 () { # ~ 60s
4807 # This tests are duplicated from component_test_aesni for i386 target
4808 #
4809 # AESNI intrinsic code supports i386 and assembly code does not support it.
4810
4811 msg "build: default config with different AES implementations"
4812 scripts/config.py set MBEDTLS_AESNI_C
4813 scripts/config.py set MBEDTLS_PADLOCK_C
4814 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4815 scripts/config.py set MBEDTLS_HAVE_ASM
4816
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004817 # test the intrinsics implementation with gcc
4818 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004819 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004820 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004821 # check that we built intrinsics - this should be used by default when supported by the compiler
4822 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4823 grep -q "AES note: using AESNI" ./programs/test/selftest
4824 grep -q "AES note: built-in implementation." ./programs/test/selftest
4825 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4826 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4827
4828 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004829 scripts/config.py unset MBEDTLS_PADLOCK_C
4830 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4831 msg "AES tests, test AESNI only"
4832 make clean
4833 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4834 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4835 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4836 grep -q "AES note: using AESNI" ./programs/test/selftest
4837 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4838 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4839 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4840}
4841
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004842support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004843 # clang >= 4 is required to build with target attributes
4844 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004845}
4846
4847component_test_aesni_m32_clang() {
4848
4849 scripts/config.py set MBEDTLS_AESNI_C
4850 scripts/config.py set MBEDTLS_PADLOCK_C
4851 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4852 scripts/config.py set MBEDTLS_HAVE_ASM
4853
4854 # test the intrinsics implementation with clang
4855 msg "AES tests, test intrinsics (clang)"
4856 make clean
4857 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4858 # check that we built intrinsics - this should be used by default when supported by the compiler
4859 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4860 grep -q "AES note: using AESNI" ./programs/test/selftest
4861 grep -q "AES note: built-in implementation." ./programs/test/selftest
4862 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4863 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4864}
4865
Jerry Yu193cbc02023-08-03 17:06:29 +08004866# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4867component_build_aes_aesce_armcc () {
4868 msg "Build: AESCE test on arm64 platform without plain C."
4869 scripts/config.py baremetal
4870
4871 # armc[56] don't support SHA-512 intrinsics
4872 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4873
4874 # Stop armclang warning about feature detection for A64_CRYPTO.
4875 # With this enabled, the library does build correctly under armclang,
4876 # but in baremetal builds (as tested here), feature detection is
4877 # unavailable, and the user is notified via a #warning. So enabling
4878 # this feature would prevent us from building with -Werror on
4879 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004880 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004881 scripts/config.py set MBEDTLS_HAVE_ASM
4882
4883 msg "AESCE, build with default configuration."
4884 scripts/config.py set MBEDTLS_AESCE_C
4885 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4886 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4887
4888 msg "AESCE, build AESCE only"
4889 scripts/config.py set MBEDTLS_AESCE_C
4890 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4891 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4892}
4893
Dave Rodgman0c584032023-10-08 12:26:54 +01004894support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004895 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004896 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004897}
4898
4899component_build_aes_armce () {
4900 # Test variations of AES with Armv8 crypto extensions
4901 scripts/config.py set MBEDTLS_AESCE_C
4902 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4903
4904 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004905 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004906
4907 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4908 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4909
4910 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4911 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4912
Dave Rodgman5e419372023-10-23 15:30:20 +01004913 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004914
Dave Rodgman5e419372023-10-23 15:30:20 +01004915 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4916 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004917
Dave Rodgman5e419372023-10-23 15:30:20 +01004918 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4919 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004920
Dave Rodgman5e419372023-10-23 15:30:20 +01004921 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4922 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004923
4924 # test for presence of AES instructions
4925 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4926 msg "clang, test A32 crypto instructions built"
4927 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4928 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4929 msg "clang, test T32 crypto instructions built"
4930 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4931 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4932 msg "clang, test aarch64 crypto instructions built"
4933 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4934 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4935
4936 # test for absence of AES instructions
4937 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4938 scripts/config.py unset MBEDTLS_AESCE_C
4939 msg "clang, test A32 crypto instructions not built"
4940 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4941 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4942 msg "clang, test T32 crypto instructions not built"
4943 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4944 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4945 msg "clang, test aarch64 crypto instructions not built"
4946 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4947 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004948}
4949
Dave Rodgman9ed18532023-10-05 00:06:47 +01004950support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004951 # clang >= 4 is required to build with SHA extensions
4952 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004953}
4954
Dave Rodgmand9e80832023-10-04 17:17:46 +01004955component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004956 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004957
4958
4959 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004960 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004961 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4962 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4963 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4964 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4965 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004966
Dave Rodgmand9e80832023-10-04 17:17:46 +01004967
Dave Rodgman94a634d2023-10-10 12:59:29 +01004968 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004969 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004970 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4971 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4972 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004973
Dave Rodgman5b89c552023-10-10 14:59:02 +01004974 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004975 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4976 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4977 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004978
Dave Rodgmancd654002023-10-05 09:40:07 +01004979
Dave Rodgman94a634d2023-10-10 12:59:29 +01004980 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004981 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004982 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4983 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4984 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4985 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4986 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004987
Dave Rodgmancd654002023-10-05 09:40:07 +01004988
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004989 # examine the disassembly for presence of SHA instructions
4990 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4991 scripts/config.py set ${opt}
4992 msg "${opt} clang, test A32 crypto instructions built"
4993 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4994 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4995
4996 msg "${opt} clang, test T32 crypto instructions built"
4997 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4998 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4999
5000 msg "${opt} clang, test aarch64 crypto instructions built"
5001 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5002 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5003 scripts/config.py unset ${opt}
5004 done
5005
5006
5007 # examine the disassembly for absence of SHA instructions
5008 msg "clang, test A32 crypto instructions not built"
5009 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5010 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5011
5012 msg "clang, test T32 crypto instructions not built"
5013 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5014 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5015
5016 msg "clang, test aarch64 crypto instructions not built"
5017 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5018 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005019}
5020
Jerry Yuc935aa62023-08-03 17:08:27 +08005021# For timebeing, no VIA Padlock platform available.
5022component_build_aes_via_padlock () {
5023
5024 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005025 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005026 scripts/config.py set MBEDTLS_PADLOCK_C
5027 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005028 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005029 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005030
5031}
5032
5033support_build_aes_via_padlock_only () {
5034 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5035 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5036 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5037}
5038
Jerry Yu193cbc02023-08-03 17:06:29 +08005039support_build_aes_aesce_armcc () {
5040 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005041}
5042
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005043component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005044 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005045 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005046 scripts/config.py unset MBEDTLS_PADLOCK_C
5047
Dave Rodgmand8d64512023-12-19 12:20:21 +00005048 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005049
5050 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5051 make test
5052}
5053
5054component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5055 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5056 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005057 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5058 scripts/config.py unset MBEDTLS_PADLOCK_C
5059
Hanno Becker83ebf782017-07-07 12:29:15 +01005060 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005061
5062 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005063 make test
5064}
Gilles Peskine8f073122018-11-27 15:58:47 +01005065
Hanno Becker83ebf782017-07-07 12:29:15 +01005066component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005067 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5068 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5069 scripts/config.py unset MBEDTLS_PADLOCK_C
5070 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005071 scripts/config.py unset MBEDTLS_AESCE_C
5072
Dave Rodgmand8d64512023-12-19 12:20:21 +00005073 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005074
5075 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005076 make test
5077
5078 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5079 programs/test/selftest
5080}
5081
Matthias Schulz0767fda2024-02-07 10:46:28 +01005082component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005083 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5084 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005085 scripts/config.py unset MBEDTLS_PADLOCK_C
5086 scripts/config.py unset MBEDTLS_AESNI_C
5087 scripts/config.py unset MBEDTLS_AESCE_C
5088
5089 make CFLAGS='-O2 -Werror -Wall -Wextra'
5090
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005091 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005092 make test
5093}
5094
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005095component_test_aes_fewer_tables () {
5096 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005097 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005098 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005099
Gilles Peskine7c652162017-12-11 00:01:40 +01005100 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005101 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005102}
5103
5104component_test_aes_rom_tables () {
5105 msg "build: default config with AES_ROM_TABLES enabled"
5106 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005107 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005108
5109 msg "test: AES_ROM_TABLES"
5110 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005111}
5112
Gilles Peskine14c3c062018-01-29 21:25:12 +01005113component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005114 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5115 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5116 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005117 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005118
Gilles Peskine8f073122018-11-27 15:58:47 +01005119 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5120 make test
5121}
5122
Yanray Wang49cd4b52023-11-10 11:58:37 +08005123# helper for common_block_cipher_no_decrypt() which:
5124# - enable/disable the list of config options passed from -s/-u respectively.
5125# - build
5126# - test for tests_suite_xxx
5127# - selftest
5128#
5129# Usage: helper_block_cipher_no_decrypt_build_test
5130# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5131# Options: -s set_opts the list of config options to enable
5132# -u unset_opts the list of config options to disable
5133# -c cflags the list of options passed to CFLAGS
5134# -l ldflags the list of options passed to LDFLAGS
5135helper_block_cipher_no_decrypt_build_test () {
5136 while [ $# -gt 0 ]; do
5137 case "$1" in
5138 -s)
5139 shift; local set_opts="$1";;
5140 -u)
5141 shift; local unset_opts="$1";;
5142 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005143 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005144 -l)
5145 shift; local ldflags="$1";;
5146 esac
5147 shift
5148 done
5149 set_opts="${set_opts:-}"
5150 unset_opts="${unset_opts:-}"
5151 cflags="${cflags:-}"
5152 ldflags="${ldflags:-}"
5153
Yanray Wangb2d6e522023-11-13 16:57:47 +08005154 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5155 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005156
5157 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5158 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005159 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005160
5161 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5162 not grep mbedtls_aes_setkey_dec library/aes.o
5163 not grep mbedtls_aria_setkey_dec library/aria.o
5164 not grep mbedtls_camellia_setkey_dec library/camellia.o
5165 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5166 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005167 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5168 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005169
5170 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5171 make test
5172
5173 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5174 programs/test/selftest
5175}
5176
5177# This is a common configuration function used in:
5178# - component_test_block_cipher_no_decrypt_aesni_legacy()
5179# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5180# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5181# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5182# on x86.
5183common_block_cipher_no_decrypt () {
5184 # test AESNI intrinsics
5185 helper_block_cipher_no_decrypt_build_test \
5186 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005187 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005188
5189 # test AESNI assembly
5190 helper_block_cipher_no_decrypt_build_test \
5191 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005192 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005193
5194 # test AES C implementation
5195 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005196 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005197
5198 # test AESNI intrinsics for i386 target
5199 helper_block_cipher_no_decrypt_build_test \
5200 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005201 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005202 -l "-m32"
5203}
5204
Yanray Wang3ae11992023-11-13 17:32:09 +08005205# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5206# usage: 0: no PSA crypto configuration
5207# 1: use PSA crypto configuration
5208config_block_cipher_no_decrypt () {
5209 use_psa=$1
5210
Yanray Wang66111392023-10-31 18:54:54 +08005211 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005212 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5213 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005214 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005215 scripts/config.py unset MBEDTLS_NIST_KW_C
5216
Yanray Wang3ae11992023-11-13 17:32:09 +08005217 if [ "$use_psa" -eq 1 ]; then
5218 # Enable support for cryptographic mechanisms through the PSA API.
5219 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5220 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5221 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5222 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5223 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5224 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5225 fi
5226}
5227
5228component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005229 # This consistently causes an llvm crash on clang 3.8, so use gcc
5230 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005231 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005232 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005233}
5234
Yanray Wangf1496402023-11-01 18:55:13 +08005235component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005236 # This consistently causes an llvm crash on clang 3.8, so use gcc
5237 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005238 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005239 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005240}
5241
Yanray Wang66111392023-10-31 18:54:54 +08005242support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005243 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005244}
5245
Yanray Wang66111392023-10-31 18:54:54 +08005246component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005247 scripts/config.py baremetal
5248
5249 # armc[56] don't support SHA-512 intrinsics
5250 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5251
5252 # Stop armclang warning about feature detection for A64_CRYPTO.
5253 # With this enabled, the library does build correctly under armclang,
5254 # but in baremetal builds (as tested here), feature detection is
5255 # unavailable, and the user is notified via a #warning. So enabling
5256 # this feature would prevent us from building with -Werror on
5257 # armclang. Tracked in #7198.
5258 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5259 scripts/config.py set MBEDTLS_HAVE_ASM
5260
Yanray Wang3ae11992023-11-13 17:32:09 +08005261 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005262
5263 # test AESCE baremetal build
5264 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005265 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005266 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005267
Yanray Wangef1b04d2023-09-08 11:09:26 +08005268 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5269 not grep mbedtls_aes_setkey_dec library/aes.o
5270 not grep mbedtls_aria_setkey_dec library/aria.o
5271 not grep mbedtls_camellia_setkey_dec library/camellia.o
5272 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5273 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005274 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005275 not grep mbedtls_aesce_inverse_key library/aesce.o
5276 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005277}
5278
Gilles Peskine592f5912019-10-07 18:49:32 +02005279component_test_ctr_drbg_aes_256_sha_256 () {
5280 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5281 scripts/config.py full
5282 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5283 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005284 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005285 make
5286
5287 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5288 make test
5289}
5290
5291component_test_ctr_drbg_aes_128_sha_512 () {
5292 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005293 scripts/config.py full
5294 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5295 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005296 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005297 make
5298
5299 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5300 make test
5301}
5302
5303component_test_ctr_drbg_aes_128_sha_256 () {
5304 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005305 scripts/config.py full
5306 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5307 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5308 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005309 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005310 make
5311
5312 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5313 make test
5314}
5315
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005316component_test_se_default () {
5317 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005318 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005319 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005320
5321 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5322 make test
5323}
5324
Steven Cooremand57203d2020-07-16 20:28:59 +02005325component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005326 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005327 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005328 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005329 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5330 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005331 loc_cflags="${loc_cflags} -I../tests/include -O2"
5332
Gilles Peskine21570cf2023-12-22 11:49:50 +01005333 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005334
Gilles Peskine1997f302023-07-26 18:45:20 +02005335 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005336 make test
5337}
5338
Gilles Peskine8f073122018-11-27 15:58:47 +01005339component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005340 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005341 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005342 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005343 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005344}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005345
Gilles Peskinecf740502019-07-03 20:43:05 +02005346component_test_cmake_shared () {
5347 msg "build/test: cmake shared" # ~ 2min
5348 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5349 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005350 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005351 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005352 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005353}
5354
Gilles Peskineec10bf12019-09-20 19:56:06 +02005355test_build_opt () {
5356 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005357 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005358 for opt in "$@"; do
5359 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005360 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005361 # We're confident enough in compilers to not run _all_ the tests,
5362 # but at least run the unit tests. In particular, runs with
5363 # optimizations use inline assembly whereas runs with -O0
5364 # skip inline assembly.
5365 make test # ~30s
5366 make clean
5367 done
5368}
5369
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005370# For FreeBSD we invoke the function by name so this condition is added
5371# to disable the existing test_clang_opt function for linux.
5372if [[ $(uname) != "Linux" ]]; then
5373 component_test_clang_opt () {
5374 scripts/config.py full
5375 test_build_opt 'full config' clang -O0 -Os -O2
5376 }
5377fi
5378
5379component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005380 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005381 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005382}
5383support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005384 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005385}
5386
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005387component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005388 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005389 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005390}
5391support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005392 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005393}
5394
5395component_test_gcc_latest_opt () {
5396 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005397 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005398}
5399support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005400 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005401}
5402
5403component_test_gcc_earliest_opt () {
5404 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005405 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005406}
5407support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005408 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005409}
5410
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005411component_build_mbedtls_config_file () {
5412 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005413 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005414 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005415 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005416 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005417 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5418 make clean
5419
5420 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5421 # In the user config, disable one feature (for simplicity, pick a feature
5422 # that nothing else depends on).
5423 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005424 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005425 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5426
5427 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005428}
5429
Gilles Peskine7d904e72022-04-07 21:59:14 +02005430component_build_psa_config_file () {
5431 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5432 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5433 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5434 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5435 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005436 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005437 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5438 make clean
5439
5440 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5441 # In the user config, disable one feature, which will reflect on the
5442 # mbedtls configuration so we can query it with query_compile_time_config.
5443 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5444 scripts/config.py unset MBEDTLS_CMAC_C
5445 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5446 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5447
5448 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005449}
5450
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005451component_build_psa_alt_headers () {
5452 msg "build: make with PSA alt headers" # ~20s
5453
5454 # Generate alternative versions of the substitutable headers with the
5455 # same content except different include guards.
5456 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5457
5458 # Build the library and some programs.
5459 # Don't build the fuzzers to avoid having to go through hoops to set
5460 # a correct include path for programs/fuzz/Makefile.
5461 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
5462 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\"'"
5463
5464 # Check that we're getting the alternative include guards and not the
5465 # original include guards.
5466 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5467 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5468 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5469 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5470}
5471
Dave Rodgman852de3c2023-12-14 14:46:45 +00005472component_test_m32_no_asm () {
5473 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005474 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005475 #
5476 # Note that we require gcc, because clang Asan builds fail to link for
5477 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005478 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005479 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005480 scripts/config.py unset MBEDTLS_HAVE_ASM
5481 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005482 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005483 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005484
Dave Rodgman852de3c2023-12-14 14:46:45 +00005485 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005486 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005487}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005488support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005489 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005490 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005491 *) false;;
5492 esac
5493}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005494
Gilles Peskineff0aee02021-10-05 09:36:03 +02005495component_test_m32_o2 () {
5496 # Build with optimization, to use the i386 specific inline assembly
5497 # and go faster for tests.
5498 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005499 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005500 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005501 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005502
Gilles Peskineff0aee02021-10-05 09:36:03 +02005503 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005504 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005505
Gilles Peskineff0aee02021-10-05 09:36:03 +02005506 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005507 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005508}
Gilles Peskinecf522222021-10-07 19:25:29 +02005509support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005510 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005511}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005512
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005513component_test_m32_everest () {
5514 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005515 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005516 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005517 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005518
5519 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5520 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005521
5522 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005523 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005524
5525 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5526 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005527 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005528}
5529support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005530 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005531}
5532
Gilles Peskine8f073122018-11-27 15:58:47 +01005533component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005534 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005535 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005536 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005537
5538 msg "test: 64-bit ILP32, make, gcc"
5539 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005540}
Gilles Peskine878cf602019-01-06 20:50:38 +00005541support_test_mx32 () {
5542 case $(uname -m) in
5543 amd64|x86_64) true;;
5544 *) false;;
5545 esac
5546}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005547
Peter Kolbus60c6da22018-12-27 06:59:04 -06005548component_test_min_mpi_window_size () {
5549 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005550 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005551 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005552 make
5553
5554 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5555 make test
5556}
5557
Gilles Peskine8f073122018-11-27 15:58:47 +01005558component_test_have_int32 () {
5559 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005560 scripts/config.py unset MBEDTLS_HAVE_ASM
5561 scripts/config.py unset MBEDTLS_AESNI_C
5562 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005563 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005564 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005565
Gilles Peskine8f073122018-11-27 15:58:47 +01005566 msg "test: gcc, force 32-bit bignum limbs"
5567 make test
5568}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005569
Gilles Peskine8f073122018-11-27 15:58:47 +01005570component_test_have_int64 () {
5571 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005572 scripts/config.py unset MBEDTLS_HAVE_ASM
5573 scripts/config.py unset MBEDTLS_AESNI_C
5574 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005575 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005576 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005577
Gilles Peskine8f073122018-11-27 15:58:47 +01005578 msg "test: gcc, force 64-bit bignum limbs"
5579 make test
5580}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005581
Gabor Mezeie256cc12023-07-26 17:28:48 +02005582component_test_have_int32_cmake_new_bignum () {
5583 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5584 scripts/config.py unset MBEDTLS_HAVE_ASM
5585 scripts/config.py unset MBEDTLS_AESNI_C
5586 scripts/config.py unset MBEDTLS_PADLOCK_C
5587 scripts/config.py unset MBEDTLS_AESCE_C
5588 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005589 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005590 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005591
5592 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5593 make test
5594}
5595
Gilles Peskine8f073122018-11-27 15:58:47 +01005596component_test_no_udbl_division () {
5597 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005598 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005599 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005600 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005601
Gilles Peskine8f073122018-11-27 15:58:47 +01005602 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5603 make test
5604}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005605
Gilles Peskine8f073122018-11-27 15:58:47 +01005606component_test_no_64bit_multiplication () {
5607 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005608 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005609 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005610 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005611
Gilles Peskine8f073122018-11-27 15:58:47 +01005612 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5613 make test
5614}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005615
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005616component_test_no_strings () {
5617 msg "build: no strings" # ~10s
5618 scripts/config.py full
5619 # Disable options that activate a large amount of string constants.
5620 scripts/config.py unset MBEDTLS_DEBUG_C
5621 scripts/config.py unset MBEDTLS_ERROR_C
5622 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5623 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005624 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005625
5626 msg "test: no strings" # ~ 10s
5627 make test
5628}
5629
Hanno Beckerc5722d12020-10-09 11:10:42 +01005630component_test_no_x509_info () {
5631 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5632 scripts/config.pl full
5633 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5634 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005635 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005636
5637 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5638 make test
5639
5640 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005641 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005642}
5643
Gilles Peskine8f073122018-11-27 15:58:47 +01005644component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005645 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005646 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005647 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 +02005648
Gilles Peskinee36fe812021-09-01 20:00:33 +02005649 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005650 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005651}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005652
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005653component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005654 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005655 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005656 # Build for a target platform that's close to what Debian uses
5657 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005658 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005659 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005660 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005661 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'
5662
Gilles Peskinee36fe812021-09-01 20:00:33 +02005663 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005664 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005665}
5666support_build_arm_linux_gnueabi_gcc_arm5vte () {
5667 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5668}
5669
5670component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005671 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005672 scripts/config.py baremetal
5673 # This is an imperfect substitute for
5674 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005675 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005676 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 +02005677
Gilles Peskinee36fe812021-09-01 20:00:33 +02005678 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005679 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005680}
5681
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005682component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005683 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5684 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005685 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 +02005686
Gilles Peskinee36fe812021-09-01 20:00:33 +02005687 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005688 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005689 for lib in library/*.a; do
5690 echo "$lib:"
5691 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5692 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005693}
5694
Gilles Peskine8f073122018-11-27 15:58:47 +01005695component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005696 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005697 scripts/config.py baremetal
5698 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005699 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 +01005700 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005701 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005702}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005703
Gilles Peskine8f073122018-11-27 15:58:47 +01005704component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005705 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005706 scripts/config.py baremetal
5707 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005708 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 +01005709 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005710 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005711}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005712
Dave Rodgman8c315f22023-06-02 10:26:24 -04005713component_build_arm_clang_thumb () {
5714 # ~ 30s
5715
5716 scripts/config.py baremetal
5717
5718 msg "build: clang thumb 2, make"
5719 make clean
5720 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5721
5722 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5723 msg "build: clang thumb 1 -O0, make"
5724 make clean
5725 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5726
5727 msg "build: clang thumb 1 -Os, make"
5728 make clean
5729 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5730}
5731
Gilles Peskine8f073122018-11-27 15:58:47 +01005732component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005733 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005734 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005735 # armc[56] don't support SHA-512 intrinsics
5736 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005737
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005738 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5739 scripts/config.py unset MBEDTLS_AESCE_C
5740
Dave Rodgman0fddf822023-03-02 15:32:12 +00005741 # Stop armclang warning about feature detection for A64_CRYPTO.
5742 # With this enabled, the library does build correctly under armclang,
5743 # but in baremetal builds (as tested here), feature detection is
5744 # unavailable, and the user is notified via a #warning. So enabling
5745 # this feature would prevent us from building with -Werror on
5746 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005747 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005748
Hanno Beckerf0762e92022-07-15 12:08:19 +01005749 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005750
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005751 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005752
5753 msg "size: ARM Compiler 5"
5754 "$ARMC5_FROMELF" -z library/*.o
5755
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005756 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005757
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005758 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005759 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005760
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005761 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005762 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5763
5764 # ARM Compiler 6 - Target ARMv7-M+DSP
5765 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005766
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005767 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005768 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005769
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005770 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005771 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005772
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005773 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5774 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5775
Dave Rodgman99318e62023-05-24 12:27:42 +01005776 # ARM Compiler 6 - Target Cortex-M0
5777 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005778
5779 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5780 #
5781 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5782 # that we have in our CI
5783 scripts/config.py set MBEDTLS_AESCE_C
5784 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005785}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005786
Pengyu Lvdf070032023-02-24 16:03:31 +08005787support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005788 armc5_cc="$ARMC5_BIN_DIR/armcc"
5789 armc6_cc="$ARMC6_BIN_DIR/armclang"
5790 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005791}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005792
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005793component_test_tls13_only () {
5794 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3, without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005795 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005796 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005797 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5798
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005799 msg "test: TLS 1.3 only, all key exchange modes enabled"
5800 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005801
Ronald Cronc3f43b62022-10-17 17:35:32 +02005802 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5803 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005804}
5805
Ronald Cronc3f43b62022-10-17 17:35:32 +02005806component_test_tls13_only_psk () {
5807 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5808 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5809 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5810 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005811 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005812 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5813 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5814 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5815 scripts/config.py unset MBEDTLS_ECDSA_C
5816 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005817 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005818 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005819 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5820
Ronald Cronc3f43b62022-10-17 17:35:32 +02005821 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5822 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005823
Ronald Cronc3f43b62022-10-17 17:35:32 +02005824 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5825 tests/ssl-opt.sh
5826}
5827
5828component_test_tls13_only_ephemeral () {
5829 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5830 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5831 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005832 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005833 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5834
5835 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5836 cd tests; ./test_suite_ssl; cd ..
5837
5838 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5839 tests/ssl-opt.sh
5840}
5841
Przemek Stekiela01c2422023-06-13 10:46:48 +02005842component_test_tls13_only_ephemeral_ffdh () {
5843 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5844 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5845 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5846 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005847 scripts/config.py unset MBEDTLS_ECDH_C
5848
Przemek Stekiela01c2422023-06-13 10:46:48 +02005849 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5850
5851 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5852 cd tests; ./test_suite_ssl; cd ..
5853
5854 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5855 tests/ssl-opt.sh
5856}
5857
Ronald Cronc3f43b62022-10-17 17:35:32 +02005858component_test_tls13_only_psk_ephemeral () {
5859 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5860 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5861 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5862 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5863 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5864 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5865 scripts/config.py unset MBEDTLS_ECDSA_C
5866 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005867 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005868 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005869 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5870
5871 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5872 cd tests; ./test_suite_ssl; cd ..
5873
5874 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5875 tests/ssl-opt.sh
5876}
5877
Przemek Stekiela01c2422023-06-13 10:46:48 +02005878component_test_tls13_only_psk_ephemeral_ffdh () {
5879 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5880 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5881 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5882 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5883 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5884 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5885 scripts/config.py unset MBEDTLS_ECDSA_C
5886 scripts/config.py unset MBEDTLS_PKCS1_V21
5887 scripts/config.py unset MBEDTLS_PKCS7_C
5888 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005889 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005890 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5891
5892 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5893 cd tests; ./test_suite_ssl; cd ..
5894
5895 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5896 tests/ssl-opt.sh
5897}
5898
Ronald Cronc3f43b62022-10-17 17:35:32 +02005899component_test_tls13_only_psk_all () {
5900 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5901 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5902 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5903 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5904 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5905 scripts/config.py unset MBEDTLS_ECDSA_C
5906 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005907 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005908 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005909 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5910
5911 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5912 cd tests; ./test_suite_ssl; cd ..
5913
5914 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5915 tests/ssl-opt.sh
5916}
5917
5918component_test_tls13_only_ephemeral_all () {
5919 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5920 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005921 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005922 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5923
5924 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5925 cd tests; ./test_suite_ssl; cd ..
5926
5927 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5928 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005929}
5930
Ronald Cron6f135e12021-12-08 16:57:54 +01005931component_test_tls13 () {
5932 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5933 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005934 scripts/config.py set MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5935 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005936 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005937 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005938 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005939 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005940 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005941 msg "ssl-opt.sh (TLS 1.3)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005942 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005943}
5944
Ronald Cron6f135e12021-12-08 16:57:54 +01005945component_test_tls13_no_compatibility_mode () {
5946 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5947 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005948 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5949 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005950 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005951 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005952 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005953 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005954 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005955 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005956 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005957}
5958
Gilles Peskine8f073122018-11-27 15:58:47 +01005959component_build_mingw () {
5960 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005961 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 +00005962
Gilles Peskine8f073122018-11-27 15:58:47 +01005963 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005964 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 +01005965 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005966
Gilles Peskine8f073122018-11-27 15:58:47 +01005967 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005968 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
5969 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 +01005970 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005971
Pengyu Lv158eead2023-10-19 11:27:05 +08005972 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005973 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005974 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 +01005975 make WINDOWS_BUILD=1 clean
5976}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005977support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005978 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5979 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005980 *) true;;
5981 esac
5982}
Simon Butcher91aef332016-11-17 09:20:50 +00005983
Gilles Peskine8f073122018-11-27 15:58:47 +01005984component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005985 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005986 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005987 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5988 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005989
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005990 msg "test: main suites (MSan)" # ~ 10s
5991 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005992
Gilles Peskine6848d172023-11-02 19:58:03 +01005993 msg "test: metatests (MSan)"
5994 tests/scripts/run-metatests.sh any msan
5995
Gilles Peskine82b27272019-06-14 18:27:03 +02005996 msg "program demos (MSan)" # ~20s
5997 tests/scripts/run_demos.py
5998
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005999 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006000 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006001
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006002 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006003
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006004 if [ "$MEMORY" -gt 0 ]; then
6005 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006006 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006007 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006008}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006009
Bence Szépkúti0354d042023-12-06 16:14:37 +01006010component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006011 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006012 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006013 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6014 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006015
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006016 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006017 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006018
Gilles Peskine636c26a2020-03-04 20:46:15 +01006019 # Optional parts (slow; currently broken on OS X because programs don't
6020 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006021 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006022 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006023 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006024 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006025 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006026
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006027 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006028 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006029 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006030 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006031
6032 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006033 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006034 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006035 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006036}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006037
Bence Szépkúti0354d042023-12-06 16:14:37 +01006038component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006039 msg "build: Release, full (clang)"
6040 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6041 scripts/config.py full
6042 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6043 make
6044
6045 msg "test: main suites, Valgrind (full config)"
6046 make memcheck
6047}
6048
Paul Elliott62dc3922021-11-25 17:29:40 +00006049support_test_cmake_out_of_source () {
6050 distrib_id=""
6051 distrib_ver=""
6052 distrib_ver_minor=""
6053 distrib_ver_major=""
6054
6055 # Attempt to parse lsb-release to find out distribution and version. If not
6056 # found this should fail safe (test is supported).
6057 if [[ -f /etc/lsb-release ]]; then
6058
6059 while read -r lsb_line; do
6060 case "$lsb_line" in
6061 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6062 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6063 esac
6064 done < /etc/lsb-release
6065
6066 distrib_ver_major="${distrib_ver%%.*}"
6067 distrib_ver="${distrib_ver#*.}"
6068 distrib_ver_minor="${distrib_ver%%.*}"
6069 fi
6070
6071 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6072 # processor (as the CI does) can create a race condition whereby the build
6073 # fails to see a generated file, despite that file actually having been
6074 # generated. This problem appears to go away with 18.04 or newer, so make
6075 # the out of source tests unsupported on Ubuntu 16.04.
6076 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6077}
6078
Gilles Peskine8f073122018-11-27 15:58:47 +01006079component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006080 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006081 # generates
6082 make neat
6083
Gilles Peskine8f073122018-11-27 15:58:47 +01006084 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006085 MBEDTLS_ROOT_DIR="$PWD"
6086 mkdir "$OUT_OF_SOURCE_DIR"
6087 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006088 # Note: Explicitly generate files as these are turned off in releases
6089 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006090 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006091
Gilles Peskine8f073122018-11-27 15:58:47 +01006092 msg "test: cmake 'out-of-source' build"
6093 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006094 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006095 # Also ensure that there are no error messages such as
6096 # "No such file or directory", which would indicate that some required
6097 # file is missing (ssl-opt.sh tolerates the absence of some files so
6098 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006099 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006100 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006101 cat ssl-opt.err >&2
6102 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006103 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006104 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006105 cd "$MBEDTLS_ROOT_DIR"
6106 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006107}
Andres AGdc192212016-08-31 17:33:13 +01006108
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006109component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006110 # Remove existing generated files so that we use the ones CMake
6111 # generates
6112 make neat
6113
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006114 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006115 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006116 # Note: Explicitly generate files as these are turned off in releases
6117 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006118 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006119 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006120}
Gilles Peskinea3000992022-02-04 00:21:12 +01006121support_test_cmake_as_subdirectory () {
6122 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006123}
6124
Chris Kayd259e342021-03-25 16:03:25 +00006125component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006126 # Remove existing generated files so that we use the ones CMake
6127 # generates
6128 make neat
6129
Chris Kayd259e342021-03-25 16:03:25 +00006130 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006131 cd programs/test/cmake_package
6132 cmake .
6133 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006134 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006135}
Gilles Peskinea3000992022-02-04 00:21:12 +01006136support_test_cmake_as_package () {
6137 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006138}
6139
6140component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006141 # Remove existing generated files so that we use the ones CMake
6142 # generates
6143 make neat
6144
Chris Kayd259e342021-03-25 16:03:25 +00006145 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006146 cd programs/test/cmake_package_install
6147 cmake .
6148 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006149 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006150}
Gilles Peskinea3000992022-02-04 00:21:12 +01006151support_test_cmake_as_package_install () {
6152 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006153}
6154
David Horstmann20550e32023-01-12 14:17:01 +00006155component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006156 # Make a copy of config file to use for the in-tree test
6157 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006158
6159 MBEDTLS_ROOT_DIR="$PWD"
6160 mkdir "$OUT_OF_SOURCE_DIR"
6161 cd "$OUT_OF_SOURCE_DIR"
6162
David Horstmann969c1452023-01-31 10:34:44 +00006163 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006164 cmake "$MBEDTLS_ROOT_DIR"
6165 make
6166
6167 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6168 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006169 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006170 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6171 make
6172
6173 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6174 # In the user config, disable one feature (for simplicity, pick a feature
6175 # that nothing else depends on).
6176 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6177
6178 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6179 make
6180 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6181
6182 rm -f user_config.h full_config.h
6183
6184 cd "$MBEDTLS_ROOT_DIR"
6185 rm -rf "$OUT_OF_SOURCE_DIR"
6186
6187 # Now repeat the test for an in-tree build:
6188
David Horstmann969c1452023-01-31 10:34:44 +00006189 # Restore config for the in-tree test
6190 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006191
David Horstmann969c1452023-01-31 10:34:44 +00006192 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006193 cmake .
6194 make
6195
6196 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6197 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006198 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006199 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6200 make
6201
6202 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6203 # In the user config, disable one feature (for simplicity, pick a feature
6204 # that nothing else depends on).
6205 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6206
6207 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6208 make
6209 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6210
6211 rm -f user_config.h full_config.h
6212}
6213support_build_cmake_custom_config_file () {
6214 support_test_cmake_out_of_source
6215}
6216
6217
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006218component_build_zeroize_checks () {
6219 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6220
6221 scripts/config.py full
6222
6223 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006224 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 +01006225}
6226
6227
Gilles Peskine8f073122018-11-27 15:58:47 +01006228component_test_zeroize () {
6229 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6230 # different combinations of compilers and optimization flags by using an
6231 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6232 # system in all cases that the script fails, so we must manually search the
6233 # output to check whether the pass string is present and no failure strings
6234 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006235
Gilles Peskine4976e822019-01-06 19:52:22 +00006236 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6237 # about a spurious message if Gdb tries and fails, so suppress that.
6238 gdb_disable_aslr=
6239 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6240 gdb_disable_aslr='set disable-randomization off'
6241 fi
6242
Gilles Peskine8f073122018-11-27 15:58:47 +01006243 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006244 for compiler in clang gcc; do
6245 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6246 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006247 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6248 grep "The buffer was correctly zeroized" test_zeroize.log
6249 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006250 rm -f test_zeroize.log
6251 make clean
6252 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006253 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006254}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006255
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006256component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006257 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006258 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006259 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006260
6261 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006262 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006263}
6264
6265support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006266 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006267 ver="$(cmake --version)"
6268 ver="${ver#cmake version }"
6269 ver_major="${ver%%.*}"
6270
6271 ver="${ver#*.}"
6272 ver_minor="${ver%%.*}"
6273
6274 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006275}
6276
Gilles Peskinec848d222022-12-09 12:23:35 +01006277component_check_code_style () {
6278 msg "Check C code style"
6279 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006280}
6281
Gilles Peskinec848d222022-12-09 12:23:35 +01006282support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006283 case $(uncrustify --version) in
6284 *0.75.1*) true;;
6285 *) false;;
6286 esac
6287}
6288
Gilles Peskine8f073122018-11-27 15:58:47 +01006289component_check_python_files () {
6290 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006291 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006292}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006293
Joe Subbianid614c0b2021-07-29 11:18:29 +01006294component_check_test_helpers () {
6295 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006296 # unittest writes out mundane stuff like number or tests run on stderr.
6297 # Our convention is to reserve stderr for actual errors, and write
6298 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006299 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006300
Joe Subbiania25ffab2021-08-06 09:41:27 +01006301 msg "unit test: translate_ciphers.py"
6302 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006303}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006304
Jerry Yud767cc42023-03-31 15:03:55 +08006305
Gilles Peskine192c72f2017-12-21 15:59:21 +01006306################################################################
6307#### Termination
6308################################################################
6309
Gilles Peskine8f073122018-11-27 15:58:47 +01006310post_report () {
6311 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006312 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006313
Gilles Peskine8f073122018-11-27 15:58:47 +01006314 final_report
6315}
6316
6317
6318
6319################################################################
6320#### Run all the things
6321################################################################
6322
Gilles Peskine5d996822020-03-28 21:09:21 +01006323# Function invoked by --error-test to test error reporting.
6324pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006325 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006326 if [ $KEEP_GOING -ne 0 ]; then
6327 echo "Expect three failing commands."
6328 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006329 # If the component doesn't run in a subshell, changing error_test_i to an
6330 # invalid integer will cause an error in the loop that runs this function.
6331 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006332 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006333 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006334 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006335 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006336 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006337 make unknown_target
6338 false "this should not be executed"
6339}
6340
Gilles Peskinee48351a2018-11-27 16:06:30 +01006341# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006342run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006343 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006344 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006345
6346 # Unconditionally create a seedfile that's sufficiently long.
6347 # Do this before each component, because a previous component may
6348 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006349 local dd_cmd
6350 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6351 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006352 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006353 esac
6354 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006355
Gilles Peskineec135542021-08-02 23:14:03 +02006356 # Run the component in a subshell, with error trapping and output
6357 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006358 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006359 # We want to keep running if the subshell fails, so 'set -e' must
6360 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006361 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006362 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006363 (
6364 if [ $QUIET -eq 1 ]; then
6365 # msg() will be silenced, so just print the component name here.
6366 echo "${current_component#component_}"
6367 exec >/dev/null
6368 fi
6369 if [ $KEEP_GOING -eq 1 ]; then
6370 # Keep "set -e" off, and run an ERR trap instead to record failures.
6371 set -E
6372 trap err_trap ERR
6373 fi
6374 # The next line is what runs the component
6375 "$@"
6376 if [ $KEEP_GOING -eq 1 ]; then
6377 trap - ERR
6378 exit $last_failure_status
6379 fi
6380 )
6381 component_status=$?
6382 if [ $KEEP_GOING -eq 1 ]; then
6383 set -e
6384 if [ $component_status -ne 0 ]; then
6385 failure_count=$((failure_count + 1))
6386 fi
6387 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006388
6389 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006390 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006391 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006392}
6393
6394# Preliminary setup
6395pre_check_environment
6396pre_initialize_variables
6397pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006398
Dave Rodgman21900632024-02-26 11:41:19 +00006399setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006400pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006401pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006402pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006403
Gilles Peskine878cf602019-01-06 20:50:38 +00006404build_status=0
6405if [ $KEEP_GOING -eq 1 ]; then
6406 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006407fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006408pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006409pre_print_configuration
6410pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006411cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006412if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006413 pre_generate_files
6414fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006415
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006416# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006417for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006418 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006419done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006420unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006421for component in $RUN_COMPONENTS; do
6422 run_component "component_$component"
6423done
Gilles Peskine8f073122018-11-27 15:58:47 +01006424
6425# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006426post_report