blob: 66bba9cc4f54f7f1d4c46cd72f5d53b060e126c0 [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_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001094 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
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
Paul Elliott16d51602024-03-05 14:54:28 +00001113 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001114 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001115
1116 # Compare reality with expectation.
1117 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001118 #
1119 # The output should be empty. When it's not:
1120 # - Each '+' line is a macro that was found but not expected. You want to
1121 # find where that macro occurs, and either replace it with PSA macros, or
1122 # add it to the exceptions list above with a justification.
1123 # - Each '-' line is a macro that was expected but not found; it means the
1124 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001125 diff -U0 $expected $found
1126
1127 rm $found $expected
1128}
1129
Gilles Peskine8f073122018-11-27 15:58:47 +01001130component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001131 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001132 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001133}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001134
Gilles Peskine192c72f2017-12-21 15:59:21 +01001135
Gilles Peskine636c26a2020-03-04 20:46:15 +01001136
Gilles Peskine192c72f2017-12-21 15:59:21 +01001137################################################################
1138#### Build and test many configurations and targets
1139################################################################
1140
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001141component_test_default_out_of_box () {
1142 msg "build: make, default config (out-of-box)" # ~1min
1143 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001144 # Disable fancy stuff
1145 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001146
1147 msg "test: main suites make, default config (out-of-box)" # ~10s
1148 make test
1149
1150 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001151 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001152
1153 msg "program demos: make, default config (out-of-box)" # ~10s
1154 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001155}
1156
Gilles Peskine8f073122018-11-27 15:58:47 +01001157component_test_default_cmake_gcc_asan () {
1158 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001159 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1160 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001161
Gilles Peskine8f073122018-11-27 15:58:47 +01001162 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1163 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001164
Gilles Peskine82b27272019-06-14 18:27:03 +02001165 msg "program demos (ASan build)" # ~10s
1166 tests/scripts/run_demos.py
1167
Gilles Peskine97bea012020-04-23 23:37:45 +02001168 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001169 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001170
Gilles Peskine6848d172023-11-02 19:58:03 +01001171 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001172 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001173
Gilles Peskine8f073122018-11-27 15:58:47 +01001174 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001175 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001176
Gilles Peskine8f073122018-11-27 15:58:47 +01001177 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001178 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001179
1180 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001181 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001182}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001183
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001184component_test_default_cmake_gcc_asan_new_bignum () {
1185 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001186 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001187 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001188 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001189
1190 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1191 make test
1192
1193 msg "test: selftest (ASan build)" # ~ 10s
1194 programs/test/selftest
1195
1196 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1197 tests/ssl-opt.sh
1198
1199 msg "test: compat.sh (ASan build)" # ~ 6 min
1200 tests/compat.sh
1201
1202 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1203 tests/context-info.sh
1204}
1205
Hanno Becker01635512019-02-26 14:27:09 +00001206component_test_full_cmake_gcc_asan () {
1207 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001208 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001209 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1210 make
1211
1212 msg "test: main suites (inc. selftests) (full config, ASan build)"
1213 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001214
Gilles Peskine97bea012020-04-23 23:37:45 +02001215 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001216 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001217
Gilles Peskine636c26a2020-03-04 20:46:15 +01001218 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001219 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001220
1221 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001222 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001223
1224 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001225 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001226}
1227
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001228
1229component_test_full_cmake_gcc_asan_new_bignum () {
1230 msg "build: full config, cmake, gcc, ASan"
1231 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001232 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001233 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001234 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001235
1236 msg "test: main suites (inc. selftests) (full config, ASan build)"
1237 make test
1238
1239 msg "test: selftest (ASan build)" # ~ 10s
1240 programs/test/selftest
1241
1242 msg "test: ssl-opt.sh (full config, ASan build)"
1243 tests/ssl-opt.sh
1244
1245 msg "test: compat.sh (full config, ASan build)"
1246 tests/compat.sh
1247
1248 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1249 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001250}
1251
Ronald Cronc3623db2020-10-29 10:51:32 +01001252component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001253 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001254 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001255 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1256 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1257 make
1258
1259 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1260 make test
1261}
1262
David Horstmann0f06bde2023-12-20 11:10:16 +00001263component_test_no_psa_copy_caller_buffers () {
1264 msg "build: full config - MBEDTLS_PSA_COPY_CALLER_BUFFERS, cmake, gcc, ASan"
1265 scripts/config.py full
1266 scripts/config.py unset MBEDTLS_PSA_COPY_CALLER_BUFFERS
1267 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1268 make
1269
1270 msg "test: full config - MBEDTLS_PSA_COPY_CALLER_BUFFERS, cmake, gcc, ASan"
1271 make test
1272}
1273
Gilles Peskinea3548672021-06-17 11:37:52 +02001274# check_renamed_symbols HEADER LIB
1275# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1276# name is LIB.
1277check_renamed_symbols () {
1278 ! nm "$2" | sed 's/.* //' |
1279 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1280}
1281
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001282component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001283 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001284 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001285 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1286 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1287 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1288 # We can only compile, not link, since our test and sample programs
1289 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1290 # is active.
1291 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001292
1293 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1294 # version is not present.
1295 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001296 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001297}
1298
Ronald Cron336678b2021-01-28 17:54:24 +01001299component_test_psa_crypto_client () {
1300 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1301 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1302 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1303 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001304 scripts/config.py unset MBEDTLS_LMS_C
1305 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Ronald Cron336678b2021-01-28 17:54:24 +01001306 make
1307
1308 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1309 make test
1310}
1311
Jaeden Amero424fa932021-05-14 08:34:32 +01001312component_test_psa_crypto_rsa_no_genprime() {
1313 msg "build: default config minus MBEDTLS_GENPRIME"
1314 scripts/config.py unset MBEDTLS_GENPRIME
1315 make
1316
1317 msg "test: default config minus MBEDTLS_GENPRIME"
1318 make test
1319}
1320
Gilles Peskine782f4112018-11-27 16:11:09 +01001321component_test_ref_configs () {
1322 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001323 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1324 # want to re-generate generated files that depend on it, quite correctly.
1325 # However this doesn't work as the generation script expects a specific
1326 # format for mbedtls_config.h, which the other files don't follow. Also,
1327 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001328 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001329 # whether they're on or off. So, disable cmake's (over-sensitive here)
1330 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001331 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001332 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001333 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001334}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001335
Gilles Peskine8f073122018-11-27 15:58:47 +01001336component_test_no_renegotiation () {
1337 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001338 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001339 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001340 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001341
Gilles Peskine8f073122018-11-27 15:58:47 +01001342 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1343 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001344
Gilles Peskine8f073122018-11-27 15:58:47 +01001345 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001346 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001347}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001348
Gilles Peskine636c26a2020-03-04 20:46:15 +01001349component_test_no_pem_no_fs () {
1350 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1351 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1352 scripts/config.py unset MBEDTLS_FS_IO
1353 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1354 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001355 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001356 make
1357
1358 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1359 make test
1360
1361 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001362 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001363}
1364
Gilles Peskine8f073122018-11-27 15:58:47 +01001365component_test_rsa_no_crt () {
1366 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001367 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001368 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001369 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001370
Gilles Peskine8f073122018-11-27 15:58:47 +01001371 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1372 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001373
Gilles Peskine8f073122018-11-27 15:58:47 +01001374 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001375 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001376
Gilles Peskine8f073122018-11-27 15:58:47 +01001377 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001378 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001379
1380 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001381 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001382}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001383
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001384component_test_no_ctr_drbg_classic () {
1385 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001386 scripts/config.py full
1387 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001388 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001389 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001390
Dave Rodgman17127e92023-12-14 16:42:48 +00001391 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001392 make
1393
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001394 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001395 make test
1396
Gilles Peskineba749042021-01-13 20:02:03 +01001397 # In this configuration, the TLS test programs use HMAC_DRBG.
1398 # The SSL tests are slow, so run a small subset, just enough to get
1399 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001400 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001401 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001402
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001403 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001404 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001405}
1406
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001407component_test_no_ctr_drbg_use_psa () {
1408 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001409 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001410 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1411 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001412
Dave Rodgman17127e92023-12-14 16:42:48 +00001413 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001414 make
1415
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001416 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1417 make test
1418
1419 # In this configuration, the TLS test programs use HMAC_DRBG.
1420 # The SSL tests are slow, so run a small subset, just enough to get
1421 # confidence that the SSL code copes with HMAC_DRBG.
1422 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001423 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001424
1425 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001426 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001427}
1428
1429component_test_no_hmac_drbg_classic () {
1430 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1431 scripts/config.py full
1432 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1433 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1434 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001435 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001436
Dave Rodgman17127e92023-12-14 16:42:48 +00001437 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001438 make
1439
1440 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001441 make test
1442
Gilles Peskinea2224342020-11-19 22:14:34 +01001443 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1444 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1445 # instead.
1446 # Test SSL with non-deterministic ECDSA. Only test features that
1447 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001448 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001449 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001450
1451 # To save time, only test one protocol version, since this part of
1452 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001453 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001454 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001455}
1456
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001457component_test_no_hmac_drbg_use_psa () {
1458 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1459 scripts/config.py full
1460 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1461 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1462 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1463
Dave Rodgman17127e92023-12-14 16:42:48 +00001464 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001465 make
1466
1467 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1468 make test
1469
1470 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1471 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1472 # instead.
1473 # Test SSL with non-deterministic ECDSA. Only test features that
1474 # might be affected by how ECDSA signature is performed.
1475 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001476 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001477
1478 # To save time, only test one protocol version, since this part of
1479 # the protocol is identical in (D)TLS up to 1.2.
1480 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001481 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001482}
1483
1484component_test_psa_external_rng_no_drbg_classic () {
1485 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1486 scripts/config.py full
1487 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001488 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001489 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001490 scripts/config.py unset MBEDTLS_ENTROPY_C
1491 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1492 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001493 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1494 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1495 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001496 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1497 # the SSL test programs don't have an RNG and can't work. Explicitly
1498 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001499 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001500
1501 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1502 make test
1503
Gilles Peskine8eb29432021-02-03 20:07:11 +01001504 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001505 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001506}
1507
1508component_test_psa_external_rng_no_drbg_use_psa () {
1509 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001510 scripts/config.py full
1511 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001512 scripts/config.py unset MBEDTLS_ENTROPY_C
1513 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1514 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001515 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1516 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1517 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001518 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001519
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001520 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001521 make test
1522
Gilles Peskine8eb29432021-02-03 20:07:11 +01001523 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001524 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001525}
1526
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001527component_test_psa_external_rng_use_psa_crypto () {
1528 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1529 scripts/config.py full
1530 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1531 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1532 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001533 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001534
1535 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1536 make test
1537
1538 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1539 tests/ssl-opt.sh -f 'Default\|opaque'
1540}
1541
Gilles Peskine801c4332023-04-28 21:04:28 +02001542component_test_psa_inject_entropy () {
1543 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1544 scripts/config.py full
1545 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1546 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1547 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1548 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1549 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1550 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001551 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 +02001552
1553 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1554 make test
1555}
1556
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001557component_test_sw_inet_pton () {
1558 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1559
1560 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1561 scripts/config.py set MBEDTLS_TEST_HOOKS
1562 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1563
1564 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1565 make test
1566}
1567
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001568component_test_crypto_full_md_light_only () {
1569 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001570 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001571 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001572 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001573 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001574 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001575 scripts/config.py unset MBEDTLS_HKDF_C
1576 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001577 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001578 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001579 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001580 # Disable things that would auto-enable MD_C
1581 scripts/config.py unset MBEDTLS_PKCS5_C
1582
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001583 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1584 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001585 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001586
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001587 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001588 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001589 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001590
1591 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001592 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001593}
1594
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001595component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001596 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001597 scripts/config.py full
1598 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001599 # Don't pull in cipher via PSA mechanisms
1600 # (currently ignored anyway because we completely disable PSA)
1601 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001602 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001603 scripts/config.py unset MBEDTLS_CMAC_C
1604 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001605 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001606 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001607 scripts/config.py unset MBEDTLS_SSL_TLS_C
1608 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001609 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001610 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1611 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001612 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001613 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001614 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001615
Valerio Settidf17a102023-10-23 14:14:19 +02001616 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001617 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001618}
1619
Valerio Setti7e710e82023-08-25 09:14:15 +02001620# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001621# - component_test_full_no_cipher_with_psa_crypto
1622# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001623# It accepts 2 input parameters:
1624# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1625# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001626common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001627 USE_CRYPTO_CONFIG="$1"
1628 COMPONENT_DESCRIPTION="$2"
1629
1630 msg "build: $COMPONENT_DESCRIPTION"
1631
1632 scripts/config.py full
1633 scripts/config.py unset MBEDTLS_CIPHER_C
1634
1635 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001636 # The built-in implementation of the following algs/key-types depends
1637 # on CIPHER_C so we disable them.
1638 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1639 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001640 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001641 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1642 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1643 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1644 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1645 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1646 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1647 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1648 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001649 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001650 else
1651 # Don't pull in cipher via PSA mechanisms
1652 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001653 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1654 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1655 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001656 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001657 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001658 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001659 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001660
Gilles Peskine21570cf2023-12-22 11:49:50 +01001661 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001662
Valerio Setti7e710e82023-08-25 09:14:15 +02001663 # Ensure that CIPHER_C was not re-enabled
1664 not grep mbedtls_cipher_init library/cipher.o
1665
1666 msg "test: $COMPONENT_DESCRIPTION"
1667 make test
1668}
1669
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001670component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001671 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001672}
1673
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001674component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001675 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001676}
1677
Valerio Settibdfecb62023-11-07 15:37:20 +01001678component_test_full_no_ccm() {
1679 msg "build: full no PSA_WANT_ALG_CCM"
1680
1681 # Full config enables:
1682 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1683 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1684 scripts/config.py full
1685
1686 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1687 # enabled, but not used from TLS since USE_PSA is set.
1688 # This is helpful to ensure that TLS tests below have proper dependencies.
1689 #
1690 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1691 # PSA_WANT_ALG_CCM to be re-enabled.
1692 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1693
Gilles Peskine21570cf2023-12-22 11:49:50 +01001694 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001695
1696 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001697 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001698}
1699
1700component_test_full_no_ccm_star_no_tag() {
1701 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1702
1703 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1704 scripts/config.py full
1705
1706 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1707 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1708 # This basically disables all unauthenticated ciphers on the PSA side, while
1709 # keeping AEADs enabled.
1710 #
1711 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1712 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1713 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1714 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1715 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1716 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1717 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1718 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1719 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1720 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1721
Gilles Peskine21570cf2023-12-22 11:49:50 +01001722 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001723
1724 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001725 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001726
1727 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001728 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001729}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001730
Valerio Settie1655b82023-01-03 15:35:25 +01001731component_test_full_no_bignum () {
1732 msg "build: full minus bignum"
1733 scripts/config.py full
1734 scripts/config.py unset MBEDTLS_BIGNUM_C
1735 # Direct dependencies of bignum
1736 scripts/config.py unset MBEDTLS_ECP_C
1737 scripts/config.py unset MBEDTLS_RSA_C
1738 scripts/config.py unset MBEDTLS_DHM_C
1739 # Direct dependencies of ECP
1740 scripts/config.py unset MBEDTLS_ECDH_C
1741 scripts/config.py unset MBEDTLS_ECDSA_C
1742 scripts/config.py unset MBEDTLS_ECJPAKE_C
1743 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001744 # Disable what auto-enables ECP_LIGHT
1745 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1746 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001747 # Indirect dependencies of ECP
1748 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1749 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1750 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1751 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1752 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1753 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1754 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1755 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1756 # Direct dependencies of DHM
1757 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1758 # Direct dependencies of RSA
1759 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1760 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1761 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1762 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1763 # PK and its dependencies
1764 scripts/config.py unset MBEDTLS_PK_C
1765 scripts/config.py unset MBEDTLS_PK_PARSE_C
1766 scripts/config.py unset MBEDTLS_PK_WRITE_C
1767 scripts/config.py unset MBEDTLS_X509_USE_C
1768 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1769 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1770 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1771 scripts/config.py unset MBEDTLS_X509_CREATE_C
1772 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1773 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1774 scripts/config.py unset MBEDTLS_PKCS7_C
1775 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1776 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1777 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1778
Gilles Peskine21570cf2023-12-22 11:49:50 +01001779 make
Valerio Settie1655b82023-01-03 15:35:25 +01001780
1781 msg "test: full minus bignum"
1782 make test
1783}
1784
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001785component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001786 msg "build: default with only stream cipher"
1787
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001788 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001789 scripts/config.py unset MBEDTLS_GCM_C
1790 scripts/config.py unset MBEDTLS_CCM_C
1791 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001792 # 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 +02001793 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001794 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001795 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001796 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1797 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001798 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001799 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001800 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001801
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001802 make
1803
1804 msg "test: default with only stream cipher"
1805 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001806
1807 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001808}
1809
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001810component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001811 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001812
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001813 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001814 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001815 scripts/config.py unset MBEDTLS_GCM_C
1816 scripts/config.py unset MBEDTLS_CCM_C
1817 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001818 # 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 +02001819 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001820 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001821 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001822 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1823 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001824 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001825 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001826 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001827
Przemek Stekiel9550c052022-09-28 09:51:55 +02001828 make
1829
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001830 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001831 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001832
1833 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001834}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001835
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001836component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001837 msg "build: default with only CBC-legacy cipher"
1838
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001839 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001840 scripts/config.py unset MBEDTLS_GCM_C
1841 scripts/config.py unset MBEDTLS_CCM_C
1842 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001843 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1844 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1845 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001846 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001847 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001848 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001849 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001850 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001851 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001852
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001853 make
1854
1855 msg "test: default with only CBC-legacy cipher"
1856 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001857
1858 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1859 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001860}
1861
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001862component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001863 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001864
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001865 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001866 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001867 scripts/config.py unset MBEDTLS_GCM_C
1868 scripts/config.py unset MBEDTLS_CCM_C
1869 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001870 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1871 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1872 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001873 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001874 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001875 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001876 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001877 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001878 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001879
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001880 make
1881
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001882 msg "test: default with only CBC-legacy cipher use psa"
1883 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001884
1885 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1886 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001887}
1888
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001889component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001890 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1891
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001892 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001893 scripts/config.py unset MBEDTLS_GCM_C
1894 scripts/config.py unset MBEDTLS_CCM_C
1895 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001896 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1897 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1898 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1899 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1900 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001901 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001902 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001903 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001904 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001905
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001906 make
1907
1908 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1909 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001910
1911 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1912 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001913}
1914
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001915component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1916 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001917
1918 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001919 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001920 scripts/config.py unset MBEDTLS_GCM_C
1921 scripts/config.py unset MBEDTLS_CCM_C
1922 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001923 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1924 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1925 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1926 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1927 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001928 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001929 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001930 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001931 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001932
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001933 make
1934
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001935 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001936 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001937
1938 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1939 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001940}
1941
Valerio Setti9f0ec532022-11-08 13:03:24 +01001942# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1943# that we could use for interop testing. However, we now have sort of two
1944# implementations ourselves: one using PSA, the other not. At least test that
1945# these two interoperate with each other.
1946component_test_tls1_2_ecjpake_compatibility() {
1947 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1948 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001949 # Explicitly make lib first to avoid a race condition:
1950 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1951 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001952 make -C programs ssl/ssl_server2 ssl/ssl_client2
1953 cp programs/ssl/ssl_server2 s2_no_use_psa
1954 cp programs/ssl/ssl_client2 c2_no_use_psa
1955
1956 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1957 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1958 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001959 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001960 make -C programs ssl/ssl_server2 ssl/ssl_client2
1961 make -C programs test/udp_proxy test/query_compile_time_config
1962
Valerio Setti70e02902022-12-02 16:21:56 +01001963 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1964 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1965 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1966 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1967 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1968 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1969 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1970 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 +01001971
1972 rm s2_no_use_psa c2_no_use_psa
1973}
1974
Gilles Peskine636c26a2020-03-04 20:46:15 +01001975component_test_everest () {
1976 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
1977 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1978 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1979 make
1980
1981 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1982 make test
1983
Gilles Peskine6848d172023-11-02 19:58:03 +01001984 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001985 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001986
Gilles Peskine636c26a2020-03-04 20:46:15 +01001987 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
1988 tests/ssl-opt.sh -f ECDH
1989
1990 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1991 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001992 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001993}
1994
Gilles Peskined3beca92020-07-03 00:15:37 +02001995component_test_everest_curve25519_only () {
1996 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02001997 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1998 scripts/config.py unset MBEDTLS_ECDSA_C
1999 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2000 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002001 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002002 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002003 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002004 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2005
Dave Rodgman17127e92023-12-14 16:42:48 +00002006 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002007
2008 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2009 make test
2010}
2011
Gilles Peskine8f073122018-11-27 15:58:47 +01002012component_test_small_ssl_out_content_len () {
2013 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002014 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2015 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002016 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002017 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002018
Gilles Peskine8f073122018-11-27 15:58:47 +01002019 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002020 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002021}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002022
Gilles Peskine8f073122018-11-27 15:58:47 +01002023component_test_small_ssl_in_content_len () {
2024 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002025 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2026 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002027 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002028 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002029
Gilles Peskine8f073122018-11-27 15:58:47 +01002030 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002031 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002032}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002033
Gilles Peskine8f073122018-11-27 15:58:47 +01002034component_test_small_ssl_dtls_max_buffering () {
2035 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002036 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002037 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002038 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002039
Gilles Peskine8f073122018-11-27 15:58:47 +01002040 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002041 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 +01002042}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002043
Gilles Peskine8f073122018-11-27 15:58:47 +01002044component_test_small_mbedtls_ssl_dtls_max_buffering () {
2045 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002046 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002047 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002048 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002049
Gilles Peskine8f073122018-11-27 15:58:47 +01002050 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002051 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002052}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002053
Gilles Peskine75cc7712019-09-06 19:47:17 +02002054component_test_psa_collect_statuses () {
2055 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002056 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002057 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002058 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002059 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002060 rm -f tests/statuses.log
2061}
2062
Gilles Peskine8f073122018-11-27 15:58:47 +01002063component_test_full_cmake_clang () {
2064 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002065 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002066 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 +01002067 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002068
k-stachowiak0291cb72019-06-26 15:52:12 +02002069 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002070 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002071
Gilles Peskineda6017c2022-10-30 21:02:40 +01002072 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2073 programs/test/cpp_dummy_build
2074
Gilles Peskine6848d172023-11-02 19:58:03 +01002075 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002076 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002077
Gilles Peskine82b27272019-06-14 18:27:03 +02002078 msg "program demos (full config, clang)" # ~10s
2079 tests/scripts/run_demos.py
2080
k-stachowiak0291cb72019-06-26 15:52:12 +02002081 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002082 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002083
Gilles Peskine8f073122018-11-27 15:58:47 +01002084 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002085 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002086
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002087 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002088 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002089
Gilles Peskine8f073122018-11-27 15:58:47 +01002090 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002091 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002092}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002093
Gilles Peskine0c671602022-11-29 16:01:41 +01002094skip_suites_without_constant_flow () {
2095 # Skip the test suites that don't have any constant-flow annotations.
2096 # This will need to be adjusted if we ever start declaring things as
2097 # secret from macros or functions inside tests/include or tests/src.
2098 SKIP_TEST_SUITES=$(
2099 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2100 sed 's/test_suite_//; s/\.function$//' |
2101 tr '\n' ,)
2102 export SKIP_TEST_SUITES
2103}
2104
Dave Rodgman246210e2023-07-31 18:07:44 +01002105skip_all_except_given_suite () {
2106 # Skip all but the given test suite
2107 SKIP_TEST_SUITES=$(
2108 ls -1 tests/suites/test_suite_*.function |
2109 grep -v $1.function |
2110 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2111 tr '\n' ,)
2112 export SKIP_TEST_SUITES
2113}
2114
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002115component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002116 # This tests both (1) accesses to undefined memory, and (2) branches or
2117 # memory access depending on secret values. To distinguish between those:
2118 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2119 # - or alternatively, change the build type to MemSanDbg, which enables
2120 # origin tracking and nicer stack traces (which are useful for debugging
2121 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002122 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2123 scripts/config.py full
2124 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2125 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2126 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2127 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2128 make
2129
2130 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2131 make test
2132}
2133
2134component_test_memsan_constant_flow_psa () {
2135 # This tests both (1) accesses to undefined memory, and (2) branches or
2136 # memory access depending on secret values. To distinguish between those:
2137 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2138 # - or alternatively, change the build type to MemSanDbg, which enables
2139 # origin tracking and nicer stack traces (which are useful for debugging
2140 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002141 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002142 scripts/config.py full
2143 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2144 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2145 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2146 make
2147
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002148 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002149 make test
2150}
2151
Bence Szépkúti0354d042023-12-06 16:14:37 +01002152component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002153 # This tests both (1) everything that valgrind's memcheck usually checks
2154 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2155 # etc.) and (2) branches or memory access depending on secret values,
2156 # which will be reported as uninitialized memory. To distinguish between
2157 # secret and actually uninitialized:
2158 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2159 # - or alternatively, build with debug info and manually run the offending
2160 # test suite with valgrind --track-origins=yes, then check if the origin
2161 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002162 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2163 scripts/config.py full
2164 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2165 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002166 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002167 cmake -D CMAKE_BUILD_TYPE:String=Release .
2168 make
2169
2170 # this only shows a summary of the results (how many of each type)
2171 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002172 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002173 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002174
2175 # Test asm path in constant time module - by default, it will test the plain C
2176 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2177 msg "test: valgrind asm constant_time"
2178 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2179 skip_all_except_given_suite test_suite_constant_time
2180 cmake -D CMAKE_BUILD_TYPE:String=Release .
2181 make clean
2182 make
2183 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002184}
2185
Bence Szépkúti0354d042023-12-06 16:14:37 +01002186component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002187 # This tests both (1) everything that valgrind's memcheck usually checks
2188 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2189 # etc.) and (2) branches or memory access depending on secret values,
2190 # which will be reported as uninitialized memory. To distinguish between
2191 # secret and actually uninitialized:
2192 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2193 # - or alternatively, build with debug info and manually run the offending
2194 # test suite with valgrind --track-origins=yes, then check if the origin
2195 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002196 msg "build: cmake release GCC, full config with constant flow testing"
2197 scripts/config.py full
2198 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002199 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002200 cmake -D CMAKE_BUILD_TYPE:String=Release .
2201 make
2202
2203 # this only shows a summary of the results (how many of each type)
2204 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002205 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002206 make memcheck
2207}
2208
Janos Follath9338cac2023-10-04 18:55:39 +01002209component_test_tsan () {
2210 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002211 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002212 scripts/config.py set MBEDTLS_THREADING_C
2213 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002214 # Self-tests do not currently use multiple threads.
2215 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002216
2217 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2218 make
2219
2220 msg "test: main suites (TSan)"
2221 make test
2222}
2223
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002224component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002225 # Test that removing the deprecated features from the default
2226 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002227 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2228 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002229 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002230
2231 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2232 make test
2233}
2234
2235component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002236 msg "build: make, full_no_deprecated config" # ~ 30s
2237 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002238 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002239
Gilles Peskine30de2e82020-04-20 21:39:22 +02002240 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002241 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002242
2243 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2244 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002245}
2246
Gilles Peskine8386ea22020-04-30 09:07:29 +02002247component_test_full_no_deprecated_deprecated_warning () {
2248 # Test that there is nothing deprecated in "full_no_deprecated".
2249 # A deprecated feature would trigger a warning (made fatal) from
2250 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002251 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2252 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002253 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2254 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002255 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002256
Gilles Peskine30de2e82020-04-20 21:39:22 +02002257 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002258 make test
2259}
2260
Gilles Peskine8386ea22020-04-30 09:07:29 +02002261component_test_full_deprecated_warning () {
2262 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2263 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002264 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002265 scripts/config.py full
2266 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002267 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002268 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2269 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002270 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002271
Gilles Peskine8386ea22020-04-30 09:07:29 +02002272 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2273 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2274 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002275 # Expect warnings from '#warning' directives in check_config.h and
2276 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002277 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 +01002278
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002279 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2280 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002281
2282 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2283 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002284}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002285
Gilles Peskineec541fe2020-01-31 14:24:14 +01002286# Check that the specified libraries exist and are empty.
2287are_empty_libraries () {
2288 nm "$@" >/dev/null 2>/dev/null
2289 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2290}
2291
2292component_build_crypto_default () {
2293 msg "build: make, crypto only"
2294 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002295 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002296 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002297}
2298
2299component_build_crypto_full () {
2300 msg "build: make, crypto only, full config"
2301 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +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
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002306component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002307 msg "build: make, config for PSA crypto service"
2308 scripts/config.py crypto
2309 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2310 # Disable things that are not needed for just cryptography, to
2311 # reach a configuration that would be typical for a PSA cryptography
2312 # service providing all implemented PSA algorithms.
2313 # System stuff
2314 scripts/config.py unset MBEDTLS_ERROR_C
2315 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002316 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002317 # Crypto stuff with no PSA interface
2318 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002319 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002320 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002321 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002322 scripts/config.py unset MBEDTLS_NIST_KW_C
2323 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2324 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2325 scripts/config.py unset MBEDTLS_PKCS12_C
2326 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002327 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2328 # in PSA code to work with RSA keys. We don't require users to set those:
2329 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002330 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002331 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002332 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002333 make CFLAGS='-O1 -Werror' all test
2334 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2335}
2336
Gilles Peskineec541fe2020-01-31 14:24:14 +01002337component_build_crypto_baremetal () {
2338 msg "build: make, crypto only, baremetal config"
2339 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002340 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002341 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002342}
Daniel Axtens446af202020-09-02 21:30:13 +10002343support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002344 support_build_baremetal "$@"
2345}
2346
2347component_build_baremetal () {
2348 msg "build: make, baremetal config"
2349 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002350 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002351}
2352support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002353 # Older Glibc versions include time.h from other headers such as stdlib.h,
2354 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2355 # problem, Ubuntu 18.04 is ok.
2356 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2357}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002358
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002359# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002360component_test_depends_py_cipher_id () {
2361 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002362 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002363}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002364
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002365component_test_depends_py_cipher_chaining () {
2366 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002367 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002368}
2369
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002370component_test_depends_py_cipher_padding () {
2371 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002372 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002373}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002374
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002375component_test_depends_py_curves () {
2376 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002377 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002378}
2379
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002380component_test_depends_py_hashes () {
2381 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002382 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002383}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002384
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002385component_test_depends_py_kex () {
2386 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002387 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002388}
2389
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002390component_test_depends_py_pkalgs () {
2391 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002392 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002393}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002394
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002395# PSA equivalents of the depends.py tests
2396component_test_depends_py_cipher_id_psa () {
2397 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002398 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002399}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002400
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002401component_test_depends_py_cipher_chaining_psa () {
2402 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002403 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002404}
2405
2406component_test_depends_py_cipher_padding_psa () {
2407 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002408 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002409}
2410
2411component_test_depends_py_curves_psa () {
2412 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002413 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002414}
2415
2416component_test_depends_py_hashes_psa () {
2417 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002418 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002419}
2420
2421component_test_depends_py_kex_psa () {
2422 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002423 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002424}
2425
2426component_test_depends_py_pkalgs_psa () {
2427 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002428 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002429}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002430
Valerio Setti6bed64e2024-01-17 15:21:44 +01002431component_test_psa_crypto_config_ffdh_2048_only () {
2432 msg "build: full config - only DH 2048"
2433
2434 scripts/config.py full
2435
2436 # Disable all DH groups other than 2048.
2437 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2438 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2439 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2440 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2441
2442 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2443
2444 msg "test: full config - only DH 2048"
2445 make test
2446
2447 msg "ssl-opt: full config - only DH 2048"
2448 tests/ssl-opt.sh -f "ffdh"
2449}
2450
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002451component_build_no_pk_rsa_alt_support () {
2452 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2453
2454 scripts/config.py full
2455 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2456 scripts/config.py set MBEDTLS_RSA_C
2457 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2458
2459 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002460 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002461}
2462
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002463component_build_module_alt () {
2464 msg "build: MBEDTLS_XXX_ALT" # ~30s
2465 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002466
2467 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002468 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2469 scripts/config.py unset MBEDTLS_AESNI_C
2470 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002471 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002472 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2473 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002474 # You can only have one threading implementation: alt or pthread, not both.
2475 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002476 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2477 # directly and assumes the implementation works with partial groups.
2478 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002479 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2480 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2481 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002482 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2483 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2484 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002485
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002486 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2487 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2488 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002489 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002490
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002491 # We can only compile, not link, since we don't have any implementations
2492 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002493 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002494}
2495
2496component_build_dhm_alt () {
2497 msg "build: MBEDTLS_DHM_ALT" # ~30s
2498 scripts/config.py full
2499 scripts/config.py set MBEDTLS_DHM_ALT
2500 # debug.c currently references mbedtls_dhm_context fields directly.
2501 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002502 # We can only compile, not link, since we don't have any implementations
2503 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002504 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002505}
2506
Gilles Peskine64996c32024-01-23 20:25:47 +01002507component_test_no_psa_crypto_full_cmake_asan() {
2508 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2509 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002510 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002511 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002512 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002513 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002514 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002515 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002516 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002517 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002518 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002519 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002520 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002521 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002522
Gilles Peskine64996c32024-01-23 20:25:47 +01002523 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002524 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002525
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002526 # Note: ssl-opt.sh has some test cases that depend on
2527 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2528 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002529 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002530 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002531
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002532 msg "test: compat.sh default (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002533 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002534
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002535 msg "test: compat.sh NULL (full minus PSA crypto)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002536 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002537
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002538 msg "test: compat.sh ARIA + ChachaPoly (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002539 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002540}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002541
Ronald Cron403c15c2021-09-13 09:38:05 +02002542component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002543 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002544
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002545 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002546 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002547 $(helper_get_psa_key_type_list "ECC") \
2548 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002549
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002550 # Configure
2551 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002552
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002553 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002554 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard6d7db932022-12-28 09:48:01 +01002555 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002556
2557 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002558 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002559
2560 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002561 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2562 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2563
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002564 # Build
2565 # -----
2566
2567 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002568 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2569 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002570
2571 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2572
Valerio Setti3fe105b2023-10-30 11:08:12 +01002573 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002574
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002575 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002576 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002577
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002578 # Run the tests
2579 # -------------
2580
Ronald Cron403c15c2021-09-13 09:38:05 +02002581 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2582 make test
2583}
2584
Valerio Setti44b178c2023-03-22 14:02:57 +01002585component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002586 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002587
2588 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002589 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002590 $(helper_get_psa_key_type_list "ECC") \
2591 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002592
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002593 # Configure
2594 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002595
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002596 # Start from default config (no TLS 1.3, no USE_PSA)
2597 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002598
Valerio Setti44b178c2023-03-22 14:02:57 +01002599 # Disable the module that's accelerated
2600 scripts/config.py unset MBEDTLS_ECDH_C
2601
2602 # Disable things that depend on it
2603 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2604 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2605 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2606 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2607 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2608
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002609 # Build
2610 # -----
2611
2612 helper_libtestdriver1_make_drivers "$loc_accel_list"
2613
Valerio Setti3fe105b2023-10-30 11:08:12 +01002614 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002615
Valerio Setti44b178c2023-03-22 14:02:57 +01002616 # Make sure this was not re-enabled by accident (additive config)
2617 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002618
2619 # Run the tests
2620 # -------------
2621
Valerio Setti44b178c2023-03-22 14:02:57 +01002622 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002623 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002624}
2625
Przemek Stekieldccb2022023-05-11 10:48:50 +02002626component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002627 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002628
2629 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002630 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002631 $(helper_get_psa_key_type_list "DH") \
2632 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002633
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002634 # Configure
2635 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002636
Przemek Stekiel565353e2023-07-05 11:07:07 +02002637 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002638 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002639
2640 # Disable the module that's accelerated
2641 scripts/config.py unset MBEDTLS_DHM_C
2642
2643 # Disable things that depend on it
2644 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2645 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2646
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002647 # Build
2648 # -----
2649
2650 helper_libtestdriver1_make_drivers "$loc_accel_list"
2651
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002652 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002653
2654 # Make sure this was not re-enabled by accident (additive config)
2655 not grep mbedtls_dhm_ library/dhm.o
2656
2657 # Run the tests
2658 # -------------
2659
Gilles Peskine14302ed2023-07-19 19:30:04 +02002660 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002661 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002662
Gilles Peskine14302ed2023-07-19 19:30:04 +02002663 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002664 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002665}
2666
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002667component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002668 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002669
2670 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002671 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002672
2673 # Disable things that are not supported
2674 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2675 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002676 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002677
Gilles Peskine14302ed2023-07-19 19:30:04 +02002678 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002679 make test
2680
Gilles Peskine14302ed2023-07-19 19:30:04 +02002681 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002682 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002683}
2684
Valerio Setti44b178c2023-03-22 14:02:57 +01002685component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002686 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002687
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002688 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002689 $(helper_get_psa_key_type_list "ECC") \
2690 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002691
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002692 # Configure
2693 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002694
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002695 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002696
2697 # Make built-in fallback not available
2698 scripts/config.py unset MBEDTLS_ECJPAKE_C
2699 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2700
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002701 # Build
2702 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002703
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002704 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002705
Valerio Setti3fe105b2023-10-30 11:08:12 +01002706 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002707
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002708 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002709 not grep mbedtls_ecjpake_init library/ecjpake.o
2710
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002711 # Run the tests
2712 # -------------
2713
Gilles Peskine14302ed2023-07-19 19:30:04 +02002714 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002715 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002716}
2717
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002718component_test_psa_crypto_config_accel_ecc_some_key_types () {
2719 msg "build: full with accelerated EC algs and some key types"
2720
2721 # Algorithms and key types to accelerate
2722 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2723 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2724 ALG_ECDH \
2725 ALG_JPAKE \
2726 KEY_TYPE_ECC_PUBLIC_KEY \
2727 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2728 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002729 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2730 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002731
2732 # Configure
2733 # ---------
2734
2735 # start with config full for maximum coverage (also enables USE_PSA)
2736 helper_libtestdriver1_adjust_config "full"
2737
2738 # Disable modules that are accelerated - some will be re-enabled
2739 scripts/config.py unset MBEDTLS_ECDSA_C
2740 scripts/config.py unset MBEDTLS_ECDH_C
2741 scripts/config.py unset MBEDTLS_ECJPAKE_C
2742 scripts/config.py unset MBEDTLS_ECP_C
2743
2744 # Disable all curves - those that aren't accelerated should be re-enabled
2745 helper_disable_builtin_curves
2746
2747 # Restartable feature is not yet supported by PSA. Once it will in
2748 # the future, the following line could be removed (see issues
2749 # 6061, 6332 and following ones)
2750 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2751
2752 # this is not supported by the driver API yet
2753 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2754
2755 # Build
2756 # -----
2757
2758 # These hashes are needed for some ECDSA signature tests.
2759 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2760 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2761 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2762
Valerio Setti3fe105b2023-10-30 11:08:12 +01002763 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002764
2765 # ECP should be re-enabled but not the others
2766 not grep mbedtls_ecdh_ library/ecdh.o
2767 not grep mbedtls_ecdsa library/ecdsa.o
2768 not grep mbedtls_ecjpake library/ecjpake.o
2769 grep mbedtls_ecp library/ecp.o
2770
2771 # Run the tests
2772 # -------------
2773
2774 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002775 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002776}
2777
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002778# Run tests with only (non-)Weierstrass accelerated
2779# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002780# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2781# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002782common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002783 weierstrass=$1
2784 if [ $weierstrass -eq 1 ]; then
2785 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002786 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002787 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002788 fi
2789
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002790 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002791
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002792 # Note: Curves are handled in a special way by the libtestdriver machinery,
2793 # so we only want to include them in the accel list when building the main
2794 # libraries, hence the use of a separate variable.
2795 # Note: the following loop is a modified version of
2796 # helper_get_psa_curve_list that only keeps Weierstrass families.
2797 loc_weierstrass_list=""
2798 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002799 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2800 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002801 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002802 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002803 ;;
2804 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002805 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002806 ;;
2807 esac
2808 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002809 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002810 loc_curve_list=$loc_weierstrass_list
2811 else
2812 loc_curve_list=$loc_non_weierstrass_list
2813 fi
2814
Valerio Setti3fe105b2023-10-30 11:08:12 +01002815 # Algorithms and key types to accelerate
2816 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2817 ALG_ECDH \
2818 ALG_JPAKE \
2819 $(helper_get_psa_key_type_list "ECC") \
2820 $loc_curve_list"
2821
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002822 # Configure
2823 # ---------
2824
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002825 # Start with config crypto_full and remove PK_C:
2826 # that's what's supported now, see docs/driver-only-builds.md.
2827 helper_libtestdriver1_adjust_config "crypto_full"
2828 scripts/config.py unset MBEDTLS_PK_C
2829 scripts/config.py unset MBEDTLS_PK_PARSE_C
2830 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002831
2832 # Disable modules that are accelerated - some will be re-enabled
2833 scripts/config.py unset MBEDTLS_ECDSA_C
2834 scripts/config.py unset MBEDTLS_ECDH_C
2835 scripts/config.py unset MBEDTLS_ECJPAKE_C
2836 scripts/config.py unset MBEDTLS_ECP_C
2837
2838 # Disable all curves - those that aren't accelerated should be re-enabled
2839 helper_disable_builtin_curves
2840
2841 # Restartable feature is not yet supported by PSA. Once it will in
2842 # the future, the following line could be removed (see issues
2843 # 6061, 6332 and following ones)
2844 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2845
2846 # this is not supported by the driver API yet
2847 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2848
2849 # Build
2850 # -----
2851
2852 # These hashes are needed for some ECDSA signature tests.
2853 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2854 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2855 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2856
Valerio Settiac7a8092023-10-31 12:23:44 +01002857 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002858
2859 # We expect ECDH to be re-enabled for the missing curves
2860 grep mbedtls_ecdh_ library/ecdh.o
2861 # We expect ECP to be re-enabled, however the parts specific to the
2862 # families of curves that are accelerated should be ommited.
2863 # - functions with mxz in the name are specific to Montgomery curves
2864 # - ecp_muladd is specific to Weierstrass curves
2865 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002866 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002867 not grep mbedtls_ecp_muladd library/ecp.o
2868 grep mxz library/ecp.o
2869 else
2870 grep mbedtls_ecp_muladd library/ecp.o
2871 not grep mxz library/ecp.o
2872 fi
2873 # We expect ECDSA and ECJPAKE to be re-enabled only when
2874 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002875 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002876 not grep mbedtls_ecdsa library/ecdsa.o
2877 not grep mbedtls_ecjpake library/ecjpake.o
2878 else
2879 grep mbedtls_ecdsa library/ecdsa.o
2880 grep mbedtls_ecjpake library/ecjpake.o
2881 fi
2882
2883 # Run the tests
2884 # -------------
2885
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002886 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2887 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002888}
2889
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002890component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002891 common_test_psa_crypto_config_accel_ecc_some_curves 1
2892}
2893
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002894component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002895 common_test_psa_crypto_config_accel_ecc_some_curves 0
2896}
2897
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002898# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2899# ECDH, ECDSA) with and without drivers.
2900# The input parameter is a boolean value which indicates:
2901# - 0 keep built-in EC algs,
2902# - 1 exclude built-in EC algs (driver only).
2903#
2904# This is used by the two following components to ensure they always use the
2905# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002906# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2907# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002908# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002909config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002910 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002911 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002912 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002913 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002914 # Disable modules that are accelerated
2915 scripts/config.py unset MBEDTLS_ECDSA_C
2916 scripts/config.py unset MBEDTLS_ECDH_C
2917 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002918 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002919 fi
2920
2921 # Restartable feature is not yet supported by PSA. Once it will in
2922 # the future, the following line could be removed (see issues
2923 # 6061, 6332 and following ones)
2924 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002925}
2926
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002927# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2928component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002929 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002930
2931 # Algorithms and key types to accelerate
2932 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2933 ALG_ECDH \
2934 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002935 $(helper_get_psa_key_type_list "ECC") \
2936 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002937
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002938 # Configure
2939 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002940
2941 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002942 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002943
Valerio Setti0a342c92023-09-01 09:12:31 +02002944 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002945 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2946 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002947
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002948 # Build
2949 # -----
2950
2951 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002952 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2953 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002954 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2955
Valerio Setti3fe105b2023-10-30 11:08:12 +01002956 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002957
2958 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2959 not grep mbedtls_ecdsa_ library/ecdsa.o
2960 not grep mbedtls_ecdh_ library/ecdh.o
2961 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002962 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002963
2964 # Run the tests
2965 # -------------
2966
Gilles Peskine14302ed2023-07-19 19:30:04 +02002967 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002968 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002969
Gilles Peskine14302ed2023-07-19 19:30:04 +02002970 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002971 tests/ssl-opt.sh
2972}
2973
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002974# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2975component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002976 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002977
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002978 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002979
Gilles Peskine21570cf2023-12-22 11:49:50 +01002980 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002981
Gilles Peskine14302ed2023-07-19 19:30:04 +02002982 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002983 make test
2984
Gilles Peskine14302ed2023-07-19 19:30:04 +02002985 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002986 tests/ssl-opt.sh
2987}
2988
Valerio Settie618cb02023-04-12 14:59:16 +02002989# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002990# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2991# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002992# to ensure that both tests use the same underlying configuration when testing
2993# driver's coverage with analyze_outcomes.py.
2994#
2995# This functions accepts 1 boolean parameter as follows:
2996# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2997# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2998# - 0: include built-in implementation of EC algorithms.
2999#
3000# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3001# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003002config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003003 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003004 # start with full config for maximum coverage (also enables USE_PSA)
3005 helper_libtestdriver1_adjust_config "full"
3006
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003007 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003008 # Disable modules that are accelerated
3009 scripts/config.py unset MBEDTLS_ECDSA_C
3010 scripts/config.py unset MBEDTLS_ECDH_C
3011 scripts/config.py unset MBEDTLS_ECJPAKE_C
3012 # Disable ECP module (entirely)
3013 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003014 fi
3015
Valerio Settiaecd32c2023-06-14 10:42:31 +02003016 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3017 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003018 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003019 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003020
Valerio Settie618cb02023-04-12 14:59:16 +02003021 # Restartable feature is not yet supported by PSA. Once it will in
3022 # the future, the following line could be removed (see issues
3023 # 6061, 6332 and following ones)
3024 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003025}
3026
3027# Build and test a configuration where driver accelerates all EC algs while
3028# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3029# side.
3030#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003031# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3032component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003033 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003034
3035 # Algorithms and key types to accelerate
3036 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3037 ALG_ECDH \
3038 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003039 $(helper_get_psa_key_type_list "ECC") \
3040 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003041
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003042 # Configure
3043 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003044
Valerio Settie618cb02023-04-12 14:59:16 +02003045 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003046 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003047 # Disable all the builtin curves. All the required algs are accelerated.
3048 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003049
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003050 # Build
3051 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003052
3053 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003054 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3055 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3056 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003057
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003058 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003059
Valerio Setti3fe105b2023-10-30 11:08:12 +01003060 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003061
3062 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3063 not grep mbedtls_ecdsa_ library/ecdsa.o
3064 not grep mbedtls_ecdh_ library/ecdh.o
3065 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003066 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003067 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003068
3069 # Run the tests
3070 # -------------
3071
Gilles Peskine14302ed2023-07-19 19:30:04 +02003072 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003073 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003074
Gilles Peskine14302ed2023-07-19 19:30:04 +02003075 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003076 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003077}
3078
3079# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003080# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003081# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003082component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003083 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003084
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003085 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003086
Gilles Peskine21570cf2023-12-22 11:49:50 +01003087 make
Valerio Settie618cb02023-04-12 14:59:16 +02003088
Gilles Peskine14302ed2023-07-19 19:30:04 +02003089 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003090 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003091
Gilles Peskine14302ed2023-07-19 19:30:04 +02003092 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003093 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003094}
3095
Valerio Setti4e2f2442023-08-15 10:10:26 +02003096# This is a common configuration helper used directly from:
3097# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3098# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3099# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003100# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003101# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003102# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003103# - this is the reference component of the above
3104# - it still disables RSA and FFDH, but it uses builtin EC algs
3105# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3106# - accelerate all EC and FFDH algs, disable only RSA
3107# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3108# - this is the reference component of the above
3109# - it still disables RSA, but it uses builtin EC and FFDH algs
3110#
3111# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003112# $1: a boolean value which states if we are testing an accelerated scenario
3113# or not.
3114# $2: a string value which states which components are tested. Allowed values
3115# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003116config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003117 driver_only="$1"
3118 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003119 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003120 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003121
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003122 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003123 # Disable modules that are accelerated
3124 scripts/config.py unset MBEDTLS_ECDSA_C
3125 scripts/config.py unset MBEDTLS_ECDH_C
3126 scripts/config.py unset MBEDTLS_ECJPAKE_C
3127 # Disable ECP module (entirely)
3128 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003129 # Also disable bignum
3130 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003131 fi
3132
3133 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3134 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3135 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3136 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3137
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003138 # RSA support is intentionally disabled on this test because RSA_C depends
3139 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003140 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3141 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 +02003142 scripts/config.py unset MBEDTLS_RSA_C
3143 scripts/config.py unset MBEDTLS_PKCS1_V15
3144 scripts/config.py unset MBEDTLS_PKCS1_V21
3145 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3146 # Also disable key exchanges that depend on RSA
3147 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3148 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3149 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3150 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3151 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3152
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003153 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003154 # When testing ECC only, we disable FFDH support, both from builtin and
3155 # PSA sides, and also disable the key exchanges that depend on DHM.
3156 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3157 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 +01003158 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003159 scripts/config.py unset MBEDTLS_DHM_C
3160 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3161 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3162 else
3163 # When testing ECC and DH instead, we disable DHM and depending key
3164 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003165 if [ "$driver_only" -eq 1 ]; then
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 fi
3170 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003171
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003172 # Restartable feature is not yet supported by PSA. Once it will in
3173 # the future, the following line could be removed (see issues
3174 # 6061, 6332 and following ones)
3175 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3176}
3177
Valerio Setti4e2f2442023-08-15 10:10:26 +02003178# Common helper used by:
3179# - component_test_psa_crypto_config_accel_ecc_no_bignum
3180# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003181#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003182# The goal is to build and test accelerating either:
3183# - ECC only or
3184# - both ECC and FFDH
3185#
3186# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003187# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3188# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003189common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003190 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003191
Valerio Setti5dfaca42023-09-05 08:48:51 +02003192 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003193 if [ "$test_target" = "ECC_DH" ]; then
3194 accel_text="ECC/FFDH"
3195 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003196 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003197 accel_text="ECC"
3198 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003199 fi
3200
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003201 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003202
3203 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003204 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3205 ALG_ECDH \
3206 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003207 $(helper_get_psa_key_type_list "ECC") \
3208 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003209 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003210 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003211 loc_accel_list="$loc_accel_list \
3212 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003213 $(helper_get_psa_key_type_list "DH") \
3214 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003215 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003216
3217 # Configure
3218 # ---------
3219
3220 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003221 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003222 # Disable all the builtin curves. All the required algs are accelerated.
3223 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003224
3225 # Build
3226 # -----
3227
3228 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003229 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3230 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3231 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003232
3233 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3234
Valerio Setti3fe105b2023-10-30 11:08:12 +01003235 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003236
3237 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3238 not grep mbedtls_ecdsa_ library/ecdsa.o
3239 not grep mbedtls_ecdh_ library/ecdh.o
3240 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003241 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003242 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003243 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003244 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003245 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003246
3247 # Run the tests
3248 # -------------
3249
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003250 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003251
Gilles Peskine21570cf2023-12-22 11:49:50 +01003252 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003253
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003254 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003255 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003256}
3257
Valerio Setti4e2f2442023-08-15 10:10:26 +02003258# Common helper used by:
3259# - component_test_psa_crypto_config_reference_ecc_no_bignum
3260# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3261#
3262# The goal is to build and test a reference scenario (i.e. with builtin
3263# components) compared to the ones used in
3264# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3265#
3266# It is meant to be used in conjunction with
3267# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3268# coverage analysis in "analyze_outcomes.py" script.
3269common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003270 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003271
Valerio Setti5dfaca42023-09-05 08:48:51 +02003272 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003273 if [ "$test_target" = "ECC_DH" ]; then
3274 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003275 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003276 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003277 fi
3278
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003279 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003280
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003281 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003282
Gilles Peskine21570cf2023-12-22 11:49:50 +01003283 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003284
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003285 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003286 make test
3287
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003288 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003289 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003290}
3291
Valerio Setti4e2f2442023-08-15 10:10:26 +02003292component_test_psa_crypto_config_accel_ecc_no_bignum () {
3293 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3294}
3295
3296component_test_psa_crypto_config_reference_ecc_no_bignum () {
3297 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3298}
3299
3300component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3301 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3302}
3303
3304component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3305 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3306}
3307
Valerio Settiac6d35f2023-08-04 12:49:11 +02003308# Helper for setting common configurations between:
3309# - component_test_tfm_config_p256m_driver_accel_ec()
3310# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003311common_tfm_config () {
3312 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003313 cp configs/config-tfm.h "$CONFIG_H"
3314 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3315 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003316
Yanray Wang73bb2312023-09-25 11:21:15 +08003317 # Other config adjustment to make the tests pass.
3318 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003319 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003320 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3321 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003322
Yanray Wang73bb2312023-09-25 11:21:15 +08003323 # Config adjustment for better test coverage in our environment.
3324 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003325 #
3326 # Enable filesystem I/O for the benefit of PK parse/write tests.
3327 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3328}
3329
Valerio Settiac6d35f2023-08-04 12:49:11 +02003330# Keep this in sync with component_test_tfm_config() as they are both meant
3331# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003332component_test_tfm_config_p256m_driver_accel_ec () {
3333 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3334
3335 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003336
Dave Rodgman897bb772023-11-15 16:34:20 +00003337 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003338 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003339
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003340 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3341 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003342 not grep mbedtls_ecdh_ library/ecdh.o
3343 not grep mbedtls_ecjpake_ library/ecjpake.o
3344 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3345 not grep mbedtls_ecp_ library/ecp.o
3346 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003347 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003348 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003349 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003350 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003351
Valerio Setti5e18b902023-12-04 12:07:30 +01003352 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3353 # files, so we want to ensure that it has not be re-enabled accidentally.
3354 not grep mbedtls_cipher library/cipher.o
3355
Valerio Settib7e95442023-03-21 11:52:33 +01003356 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003357 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003358 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003359}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003360
Valerio Settiac6d35f2023-08-04 12:49:11 +02003361# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3362# they are both meant to be used in analyze_outcomes.py for driver's coverage
3363# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003364component_test_tfm_config() {
3365 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003366
Dave Rodgman897bb772023-11-15 16:34:20 +00003367 # Disable P256M driver, which is on by default, so that analyze_outcomes
3368 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3369 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3370
Valerio Setti52ba0e32023-08-04 12:43:03 +02003371 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003372 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003373
Dave Rodgman897bb772023-11-15 16:34:20 +00003374 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003375 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003376
Valerio Setti5e18b902023-12-04 12:07:30 +01003377 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3378 # files, so we want to ensure that it has not be re-enabled accidentally.
3379 not grep mbedtls_cipher library/cipher.o
3380
Valerio Setti52ba0e32023-08-04 12:43:03 +02003381 msg "test: TF-M config"
3382 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003383}
3384
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003385# Common helper for component_full_without_ecdhe_ecdsa() and
3386# component_full_without_ecdhe_ecdsa_and_tls13() which:
3387# - starts from the "full" configuration minus the list of symbols passed in
3388# as 1st parameter
3389# - build
3390# - test only TLS (i.e. test_suite_tls and ssl-opt)
3391build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003392 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003393
3394 msg "build: full minus something, test TLS"
3395
3396 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003397 for sym in $symbols_to_disable; do
3398 echo "Disabling $sym"
3399 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003400 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003401
Gilles Peskine21570cf2023-12-22 11:49:50 +01003402 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003403
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003404 msg "test: full minus something, test TLS"
3405 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003406
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003407 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003408 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003409}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003410
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003411component_full_without_ecdhe_ecdsa () {
3412 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003413}
3414
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003415component_full_without_ecdhe_ecdsa_and_tls13 () {
3416 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3417 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003418}
3419
Valerio Setti249b18a2023-06-20 12:08:30 +02003420# This is an helper used by:
3421# - component_test_psa_ecc_key_pair_no_derive
3422# - component_test_psa_ecc_key_pair_no_generate
3423# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3424# enabled, but one. Input arguments are as follows:
3425# - $1 is the key type under test, i.e. ECC/RSA/DH
3426# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003427build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003428 key_type=$1
3429 unset_option=$2
3430 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003431
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003432 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003433 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003434 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3435 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3436
3437 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3438 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003439 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003440
Gilles Peskine21570cf2023-12-22 11:49:50 +01003441 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003442
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003443 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003444 make test
3445}
3446
3447component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003448 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003449}
3450
3451component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003452 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003453}
3454
Pengyu Lve705f572023-12-06 16:38:15 +08003455config_psa_crypto_accel_rsa () {
3456 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003457
Pengyu Lve705f572023-12-06 16:38:15 +08003458 # Start from crypto_full config (no X.509, no TLS)
3459 helper_libtestdriver1_adjust_config "crypto_full"
3460
3461 if [ "$driver_only" -eq 1 ]; then
3462 # Remove RSA support and its dependencies
3463 scripts/config.py unset MBEDTLS_RSA_C
3464 scripts/config.py unset MBEDTLS_PKCS1_V15
3465 scripts/config.py unset MBEDTLS_PKCS1_V21
3466
3467 # We need PEM parsing in the test library as well to support the import
3468 # of PEM encoded RSA keys.
3469 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3470 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3471 fi
3472}
3473
3474component_test_psa_crypto_config_accel_rsa_crypto () {
3475 msg "build: crypto_full with accelerated RSA"
3476
3477 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3478 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3479 KEY_TYPE_RSA_PUBLIC_KEY \
3480 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3481 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3482 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3483 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003484
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003485 # Configure
3486 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003487
Pengyu Lve705f572023-12-06 16:38:15 +08003488 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003489
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003490 # Build
3491 # -----
3492
Pengyu Lve705f572023-12-06 16:38:15 +08003493 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003494 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 +08003495 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003496 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003497
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003498 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003499
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003500 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003501 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003502
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003503 # Run the tests
3504 # -------------
3505
Pengyu Lve705f572023-12-06 16:38:15 +08003506 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003507 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003508}
3509
3510component_test_psa_crypto_config_reference_rsa_crypto () {
3511 msg "build: crypto_full with non-accelerated RSA"
3512
3513 # Configure
3514 # ---------
3515 config_psa_crypto_accel_rsa 0
3516
3517 # Build
3518 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003519 make
Pengyu Lve705f572023-12-06 16:38:15 +08003520
3521 # Run the tests
3522 # -------------
3523 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003524 make test
3525}
3526
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003527# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003528# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003529component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003530 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003531
Valerio Setti4590bc22023-06-13 15:39:23 +02003532 # Create a temporary output file unless there is already one set
3533 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3534 REMOVE_OUTCOME_ON_EXIT="no"
3535 else
3536 REMOVE_OUTCOME_ON_EXIT="yes"
3537 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3538 export MBEDTLS_TEST_OUTCOME_FILE
3539 fi
3540
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003541 # Start from crypto configuration
3542 scripts/config.py crypto
3543
3544 # Remove RSA support and its dependencies
3545 scripts/config.py unset MBEDTLS_PKCS1_V15
3546 scripts/config.py unset MBEDTLS_PKCS1_V21
3547 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3548 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3549 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3550 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3551 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3552 scripts/config.py unset MBEDTLS_RSA_C
3553 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3554
3555 # Enable PSA support
3556 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3557
Valerio Setti01cc88a2023-06-15 11:53:08 +02003558 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003559 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003560 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3561 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3562 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003563
3564 make
3565
Valerio Setti01cc88a2023-06-15 11:53:08 +02003566 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003567 make test
3568
3569 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3570 # performing RSA signature.
3571 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3572 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3573
3574 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3575 rm $MBEDTLS_TEST_OUTCOME_FILE
3576 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003577}
3578
Ronald Cronb2312452021-05-08 14:32:59 +02003579component_test_psa_crypto_config_accel_hash () {
3580 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3581
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003582 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3583 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3584 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003585
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003586 # Configure
3587 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003588
3589 # Start from default config (no TLS 1.3, no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003590 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003591
3592 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003593 scripts/config.py unset MBEDTLS_MD5_C
3594 scripts/config.py unset MBEDTLS_RIPEMD160_C
3595 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003596 scripts/config.py unset MBEDTLS_SHA224_C
3597 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003598 scripts/config.py unset MBEDTLS_SHA384_C
3599 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003600 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003601
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003602 # Build
3603 # -----
3604
3605 helper_libtestdriver1_make_drivers "$loc_accel_list"
3606
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003607 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003608
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003609 # There's a risk of something getting re-enabled via config_psa.h;
3610 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3611 not grep mbedtls_md5 library/md5.o
3612 not grep mbedtls_sha1 library/sha1.o
3613 not grep mbedtls_sha256 library/sha256.o
3614 not grep mbedtls_sha512 library/sha512.o
3615 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003616
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003617 # Run the tests
3618 # -------------
3619
Ronald Cronb2312452021-05-08 14:32:59 +02003620 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3621 make test
3622}
3623
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003624component_test_psa_crypto_config_accel_hash_keep_builtins () {
3625 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3626 # This component ensures that all the test cases for
3627 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3628
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003629 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3630 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3631 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003632
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003633 # Start from default config (no TLS 1.3, no USE_PSA)
3634 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003635
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003636 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003637
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003638 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003639
3640 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3641 make test
3642}
3643
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003644# Auxiliary function to build config for hashes with and without drivers
3645config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003646 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003647 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003648 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003649 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003650 # disable the built-in implementation of hashes
3651 scripts/config.py unset MBEDTLS_MD5_C
3652 scripts/config.py unset MBEDTLS_RIPEMD160_C
3653 scripts/config.py unset MBEDTLS_SHA1_C
3654 scripts/config.py unset MBEDTLS_SHA224_C
3655 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003656 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003657 scripts/config.py unset MBEDTLS_SHA384_C
3658 scripts/config.py unset MBEDTLS_SHA512_C
3659 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003660 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003661 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003662}
3663
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003664# Note that component_test_psa_crypto_config_reference_hash_use_psa
3665# is related to this component and both components need to be kept in sync.
3666# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003667component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003668 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003669
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003670 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3671 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3672 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003673
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003674 # Configure
3675 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003676
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003677 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003678
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003679 # Build
3680 # -----
3681
3682 helper_libtestdriver1_make_drivers "$loc_accel_list"
3683
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003684 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003685
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003686 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003687 # 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 +02003688 not grep mbedtls_md5 library/md5.o
3689 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003690 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003691 not grep mbedtls_sha512 library/sha512.o
3692 not grep mbedtls_ripemd160 library/ripemd160.o
3693
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003694 # Run the tests
3695 # -------------
3696
Gilles Peskine14302ed2023-07-19 19:30:04 +02003697 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003698 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003699
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003700 # This is mostly useful so that we can later compare outcome files with
3701 # the reference config in analyze_outcomes.py, to check that the
3702 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003703 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003704 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003705
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003706 # This is to make sure all ciphersuites are exercised, but we don't need
3707 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003708 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003709 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003710}
3711
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003712# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3713# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3714# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3715# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003716component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003717 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003718
3719 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003720
Gilles Peskine21570cf2023-12-22 11:49:50 +01003721 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003722
Gilles Peskine14302ed2023-07-19 19:30:04 +02003723 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003724 make test
3725
Gilles Peskine14302ed2023-07-19 19:30:04 +02003726 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003727 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003728}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003729
Valerio Setti8eb310c2024-01-22 16:22:57 +01003730# Auxiliary function to build config for hashes with and without drivers
3731config_psa_crypto_hmac_use_psa () {
3732 driver_only="$1"
3733 # start with config full for maximum coverage (also enables USE_PSA)
3734 helper_libtestdriver1_adjust_config "full"
3735
Valerio Setticd89b0b2024-01-24 14:24:55 +01003736 if [ "$driver_only" -eq 1 ]; then
3737 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3738 # is still enabled though (for ENTROPY_C among others).
3739 scripts/config.py unset MBEDTLS_MD_C
3740 # Disable also the builtin hashes since they are supported by the driver
3741 # and MD module is able to perform PSA dispathing.
3742 scripts/config.py unset-all MBEDTLS_SHA
3743 scripts/config.py unset MBEDTLS_MD5_C
3744 scripts/config.py unset MBEDTLS_RIPEMD160_C
3745 fi
3746
Valerio Setti8eb310c2024-01-22 16:22:57 +01003747 # Direct dependencies of MD_C. We disable them also in the reference
3748 # component to work with the same set of features.
3749 scripts/config.py unset MBEDTLS_PKCS7_C
3750 scripts/config.py unset MBEDTLS_PKCS5_C
3751 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3752 scripts/config.py unset MBEDTLS_HKDF_C
3753 # Dependencies of HMAC_DRBG
3754 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3755 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3756}
3757
3758component_test_psa_crypto_config_accel_hmac() {
3759 msg "test: full with accelerated hmac"
3760
3761 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3762 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3763 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3764 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3765
3766 # Configure
3767 # ---------
3768
3769 config_psa_crypto_hmac_use_psa 1
3770
Valerio Setti8eb310c2024-01-22 16:22:57 +01003771 # Build
3772 # -----
3773
3774 helper_libtestdriver1_make_drivers "$loc_accel_list"
3775
3776 helper_libtestdriver1_make_main "$loc_accel_list"
3777
3778 # Ensure that built-in support for HMAC is disabled.
3779 not grep mbedtls_md_hmac library/md.o
3780
3781 # Run the tests
3782 # -------------
3783
3784 msg "test: full with accelerated hmac"
3785 make test
3786}
3787
3788component_test_psa_crypto_config_reference_hmac() {
3789 msg "test: full without accelerated hmac"
3790
3791 config_psa_crypto_hmac_use_psa 0
3792
3793 make
3794
3795 msg "test: full without accelerated hmac"
3796 make test
3797}
3798
Valerio Setti9da01a72023-12-18 17:38:18 +01003799component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003800 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003801
Valerio Setti9da01a72023-12-18 17:38:18 +01003802 # Albeit this components aims at accelerating DES which should only support
3803 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3804 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003805 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3806 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3807 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003808
Valerio Setti9da01a72023-12-18 17:38:18 +01003809 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3810 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3811 # of this component. This limitation will be addressed by #8598.
3812
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003813 # Configure
3814 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003815
Valerio Setti9a427302023-10-17 11:40:42 +02003816 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003817 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003818
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003819 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003820 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3821 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3822 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3823 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3824 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3825 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3826 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003827 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003828
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003829 # Build
3830 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003831
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003832 helper_libtestdriver1_make_drivers "$loc_accel_list"
3833
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003834 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003835
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003836 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003837 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003838
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003839 # Run the tests
3840 # -------------
3841
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003842 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003843 make test
3844}
3845
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003846component_test_psa_crypto_config_accel_aead () {
3847 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3848
Valerio Setti3f02bb72023-10-02 15:57:33 +02003849 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3850 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003851
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003852 # Configure
3853 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003854
Valerio Setti3f02bb72023-10-02 15:57:33 +02003855 # Start from full config
3856 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003857
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003858 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003859 scripts/config.py unset MBEDTLS_GCM_C
3860 scripts/config.py unset MBEDTLS_CCM_C
3861 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003862
Valerio Settia50b89e2023-11-08 15:58:47 +01003863 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3864 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003865
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003866 # Build
3867 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003868
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003869 helper_libtestdriver1_make_drivers "$loc_accel_list"
3870
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003871 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003872
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003873 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003874 not grep mbedtls_ccm library/ccm.o
3875 not grep mbedtls_gcm library/gcm.o
3876 not grep mbedtls_chachapoly library/chachapoly.o
3877
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003878 # Run the tests
3879 # -------------
3880
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003881 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3882 make test
3883}
3884
Valerio Settib680fc42023-10-13 09:29:37 +02003885# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003886# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3887# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3888common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003889 # Start from the full config
3890 helper_libtestdriver1_adjust_config "full"
3891
Valerio Settib680fc42023-10-13 09:29:37 +02003892 scripts/config.py unset MBEDTLS_NIST_KW_C
3893}
3894
Valerio Settib6b301f2023-10-04 12:05:05 +02003895# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003896# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3897# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003898# are meant to be used together in analyze_outcomes.py script in order to test
3899# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003900component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3901 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003902
Valerio Settiad8b7f02023-10-25 12:39:50 +02003903 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 +01003904 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003905 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003906 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3907
3908 # Configure
3909 # ---------
3910
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003911 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003912
3913 # Disable the things that are being accelerated
3914 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3915 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3916 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3917 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3918 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3919 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3920 scripts/config.py unset MBEDTLS_GCM_C
3921 scripts/config.py unset MBEDTLS_CCM_C
3922 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003923 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003924 scripts/config.py unset MBEDTLS_DES_C
3925 scripts/config.py unset MBEDTLS_AES_C
3926 scripts/config.py unset MBEDTLS_ARIA_C
3927 scripts/config.py unset MBEDTLS_CHACHA20_C
3928 scripts/config.py unset MBEDTLS_CAMELLIA_C
3929
Valerio Settiec9b2582023-11-08 16:50:54 +01003930 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3931 # does not depend on it.
3932 scripts/config.py unset MBEDTLS_CIPHER_C
3933
Valerio Settib6b301f2023-10-04 12:05:05 +02003934 # Build
3935 # -----
3936
3937 helper_libtestdriver1_make_drivers "$loc_accel_list"
3938
3939 helper_libtestdriver1_make_main "$loc_accel_list"
3940
3941 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003942 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003943 not grep mbedtls_des library/des.o
3944 not grep mbedtls_aes library/aes.o
3945 not grep mbedtls_aria library/aria.o
3946 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003947 not grep mbedtls_ccm library/ccm.o
3948 not grep mbedtls_gcm library/gcm.o
3949 not grep mbedtls_chachapoly library/chachapoly.o
3950 not grep mbedtls_cmac library/cmac.o
3951
3952 # Run the tests
3953 # -------------
3954
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003955 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003956 make test
Valerio Settif9414552023-11-09 10:43:20 +01003957
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003958 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003959 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003960
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003961 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003962 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003963}
3964
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003965component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3966 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3967 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003968
Gilles Peskine21570cf2023-12-22 11:49:50 +01003969 make
Valerio Settif9414552023-11-09 10:43:20 +01003970
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003971 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003972 make test
Valerio Settif9414552023-11-09 10:43:20 +01003973
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003974 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003975 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003976
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003977 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003978 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003979}
3980
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003981common_block_cipher_dispatch() {
3982 TEST_WITH_DRIVER="$1"
3983
3984 # Start from the full config
3985 helper_libtestdriver1_adjust_config "full"
3986
3987 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3988 # Disable key types that are accelerated (there is no legacy equivalent
3989 # symbol for ECB)
3990 scripts/config.py unset MBEDTLS_AES_C
3991 scripts/config.py unset MBEDTLS_ARIA_C
3992 scripts/config.py unset MBEDTLS_CAMELLIA_C
3993 fi
3994
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003995 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003996 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003997 # Keep this also in the reference component in order to skip the same tests
3998 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003999 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4000 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4001 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4002 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4003 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4004 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4005 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004006
4007 # Disable direct dependency on AES_C
4008 scripts/config.py unset MBEDTLS_NIST_KW_C
4009
4010 # Prevent the cipher module from using deprecated PSA path. The reason is
4011 # that otherwise there will be tests relying on "aes_info" (defined in
4012 # "cipher_wrap.c") whose functions are not available when AES_C is
4013 # not defined. ARIA and Camellia are not a problem in this case because
4014 # the PSA path is not tested for these key types.
4015 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4016}
4017
Valerio Settif8e6cba2023-12-12 11:53:39 +01004018component_test_full_block_cipher_psa_dispatch () {
4019 msg "build: full + PSA dispatch in block_cipher"
4020
4021 loc_accel_list="ALG_ECB_NO_PADDING \
4022 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4023
4024 # Configure
4025 # ---------
4026
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004027 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004028
Valerio Settif8e6cba2023-12-12 11:53:39 +01004029 # Build
4030 # -----
4031
4032 helper_libtestdriver1_make_drivers "$loc_accel_list"
4033
4034 helper_libtestdriver1_make_main "$loc_accel_list"
4035
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004036 # Make sure disabled components were not re-enabled by accident (additive
4037 # config)
4038 not grep mbedtls_aes_ library/aes.o
4039 not grep mbedtls_aria_ library/aria.o
4040 not grep mbedtls_camellia_ library/camellia.o
4041
Valerio Settif8e6cba2023-12-12 11:53:39 +01004042 # Run the tests
4043 # -------------
4044
4045 msg "test: full + PSA dispatch in block_cipher"
4046 make test
4047}
4048
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004049# This is the reference component of component_test_full_block_cipher_psa_dispatch
4050component_test_full_block_cipher_legacy_dispatch () {
4051 msg "build: full + legacy dispatch in block_cipher"
4052
4053 common_block_cipher_dispatch 0
4054
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004055 make
4056
4057 msg "test: full + legacy dispatch in block_cipher"
4058 make test
4059}
4060
Gilles Peskine36dea152023-07-20 22:19:45 +02004061component_test_aead_chachapoly_disabled() {
4062 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004063 scripts/config.py full
4064 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004065 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004066 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004067
Gilles Peskine36dea152023-07-20 22:19:45 +02004068 msg "test: full minus CHACHAPOLY"
4069 make test
4070}
4071
4072component_test_aead_only_ccm() {
4073 msg "build: full minus CHACHAPOLY and GCM"
4074 scripts/config.py full
4075 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4076 scripts/config.py unset MBEDTLS_GCM_C
4077 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4078 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004079 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004080
4081 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004082 make test
4083}
4084
Ronald Crone501d0e2023-07-10 08:31:19 +02004085component_test_ccm_aes_sha256() {
4086 msg "build: CCM + AES + SHA256 configuration"
4087
Ronald Cron7612d8c2023-07-20 10:03:54 +02004088 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004089 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004090
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004091 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004092
4093 msg "test: CCM + AES + SHA256 configuration"
4094 make test
4095}
4096
John Durkopd0321952020-10-29 21:37:36 -07004097# 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 -08004098component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004099 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004100 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004101 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004102 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004103 scripts/config.py unset MBEDTLS_ECDH_C
4104 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4105 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4106 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4107 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4108 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4109 # 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 +01004110 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 -07004111}
4112
4113# 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 -08004114component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004115 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004116 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004117 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004118 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004119 # 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 +01004120 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 -07004121}
4122
4123# 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 -08004124component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004125 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004126 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004127 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004128 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004129 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004130 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4131 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004132 # 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 +01004133 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 -07004134}
4135
John Durkop1b7ee052020-11-27 08:51:22 -08004136# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4137component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004138 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004139 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004140 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004141 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004142 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4143 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4144 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4145 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4146 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4147 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4148 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004149 scripts/config.py unset MBEDTLS_LMS_C
4150 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004151 # 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 +01004152 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 -08004153}
4154
4155# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4156component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004157 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004158 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004159 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004160 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004161 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4162 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4163 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4164 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4165 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4166 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4167 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004168 scripts/config.py unset MBEDTLS_LMS_C
4169 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004170 # 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 +01004171 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 -08004172}
4173
4174# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4175component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004176 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004177 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004178 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004179 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004180 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4181 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4182 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4183 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4184 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4185 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4186 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004187 scripts/config.py unset MBEDTLS_LMS_C
4188 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004189 # 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 +01004190 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 -08004191}
4192
4193# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4194component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004195 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004196 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004197 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004198 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004199 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4200 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4201 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4202 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4203 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4204 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004205 # 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 +01004206 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 -08004207}
4208
4209# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4210component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004211 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004212 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004213 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004214 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004215 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4216 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4217 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4218 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4219 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4220 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004221 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004222 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004223}
4224
4225# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4226component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004227 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004228 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004229 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004230 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004231 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4232 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4233 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4234 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4235 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4236 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004237 scripts/config.py unset MBEDTLS_LMS_C
4238 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004239 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004240 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004241}
4242
4243# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4244component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004245 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004246 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004247 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004248 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004249 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4250 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4251 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4252 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4253 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4254 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4255 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004256 scripts/config.py unset MBEDTLS_LMS_C
4257 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004258 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004259 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004260}
4261
John Durkopd0321952020-10-29 21:37:36 -07004262# 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 -08004263component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004264 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 -07004265 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004266 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004267 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004268 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4269 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4270 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4271 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004272 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004273 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004274}
4275
4276# 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 -08004277component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004278 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 -07004279 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004280 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004281 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004282 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4283 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4284 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4285 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004286 # 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 +01004287 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 -07004288}
4289
4290# 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 -08004291component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004292 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 -07004293 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004294 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004295 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004296 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4297 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4298 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4299 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004300 # 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 +01004301 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 -07004302}
4303
4304# 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 -08004305component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004306 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 -07004307 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004308 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004309 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004310 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4311 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4312 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4313 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004314 # 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 +01004315 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 -07004316}
4317
4318# 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 -08004319component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004320 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 -07004321 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004322 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004323 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004324 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4325 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4326 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4327 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4328 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004329 # 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 +01004330 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 -07004331}
4332
4333# 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 -08004334component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004335 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 -07004336 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004337 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004338 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004339 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4340 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004341 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004342 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004343}
4344
Dave Rodgmanc164c072023-06-28 09:43:23 +01004345
Dave Rodgman904c5892023-06-28 17:36:02 +01004346support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004347 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004348}
4349
Dave Rodgman904c5892023-06-28 17:36:02 +01004350component_build_tfm_armcc() {
4351 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004352 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004353
Dave Rodgman88651c42023-06-29 12:35:51 +01004354 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004355 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 +01004356}
4357
4358component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004359 # Check that the TF-M configuration can build cleanly with various
4360 # warning flags enabled. We don't build or run tests, since the
4361 # TF-M configuration needs a TF-M platform. A tweaked version of
4362 # the configuration that works on mainstream platforms is in
4363 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004364 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004365
Dave Rodgman88651c42023-06-29 12:35:51 +01004366 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004367 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 +01004368
Dave Rodgman904c5892023-06-28 17:36:02 +01004369 msg "build: TF-M config, gcc native build"
4370 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004371 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 +01004372}
4373
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004374# Test that the given .o file builds with all (valid) combinations of the given options.
4375#
4376# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4377#
4378# The validator function is the name of a function to validate the combination of options.
4379# It may be "" if all combinations are valid.
4380# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004381# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004382build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004383 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004384 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004385 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004386 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004387 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004388
Dave Rodgman42436102023-10-03 15:47:05 +01004389 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004390 for opt in "${options[@]}"; do
4391 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004392 done
4393
4394 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004395 cd $(dirname ${file})
4396 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004397
Dave Rodgman920343a2023-10-01 18:41:09 +01004398 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004399 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 +01004400
Dave Rodgman42436102023-10-03 15:47:05 +01004401 # Extract the command generated by the Makefile to build the target file.
4402 # This ensures that we have any include paths, macro definitions, etc
4403 # that may be applied by make.
4404 # 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 +01004405 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004406
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004407 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004408 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004409
Dave Rodgman28e38d82023-10-04 11:50:30 +01004410 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004411 source_file=${file%.o}.c
4412
4413 targets=0
4414 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004415
Dave Rodgman28e38d82023-10-04 11:50:30 +01004416 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004417 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004418 # each bit of $i is used to determine if options[i] will be set or not
4419 target="t"
4420 clang_args=""
4421 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004422 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004423 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004424 clang_args="${clang_args} ${opt}"
4425 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004426 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004427 done
4428
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004429 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004430 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004431 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004432 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004433
Dave Rodgman28e38d82023-10-04 11:50:30 +01004434 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004435 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004436 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004437 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004438
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004439 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004440
Dave Rodgman920343a2023-10-01 18:41:09 +01004441 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004442 make -s -f ${makefile} build_test_config_combos
4443 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004444
4445 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004446 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004447}
4448
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004449validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004450 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4451 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004452 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004453 fi
4454 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4455 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004456 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004457 fi
4458 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004459 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004460}
4461
4462component_build_aes_variations() {
4463 # 18s - around 90ms per clang invocation on M1 Pro
4464 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004465 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004466 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004467
Yanray Wangbc29aef2023-11-06 11:08:17 +08004468 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004469 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004470
Dave Rodgman42436102023-10-03 15:47:05 +01004471 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004472 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4473 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4474 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4475 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004476
4477 cd "$MBEDTLS_ROOT_DIR"
4478 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4479
Yanray Wang42be1ba2023-11-23 14:28:47 +08004480 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004481 # manually set or unset those configurations to check
4482 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004483 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4484 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4485 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4486 scripts/config.py unset MBEDTLS_DES_C
4487 scripts/config.py unset MBEDTLS_NIST_KW_C
4488 build_test_config_combos library/aes.o validate_aes_config_variations \
4489 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4490 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4491 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4492 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004493}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004494
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004495component_test_no_platform () {
4496 # Full configuration build, without platform support, file IO and net sockets.
4497 # This should catch missing mbedtls_printf definitions, and by disabling file
4498 # IO, it should catch missing '#include <stdio.h>'
4499 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004500 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004501 scripts/config.py unset MBEDTLS_PLATFORM_C
4502 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004503 scripts/config.py unset MBEDTLS_FS_IO
4504 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004505 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004506 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004507 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004508 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004509 # to re-enable platform integration features otherwise disabled in C99 builds
4510 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004511 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004512}
Gilles Peskine7c652162017-12-11 00:01:40 +01004513
4514component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004515 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004516 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4517 scripts/config.py full
4518 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004519 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4520 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4521 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4522 make
4523}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004524
Gilles Peskine8f073122018-11-27 15:58:47 +01004525component_build_no_ssl_srv () {
4526 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004527 scripts/config.py full
4528 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004529 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004530}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004531
Gilles Peskine8f073122018-11-27 15:58:47 +01004532component_build_no_ssl_cli () {
4533 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004534 scripts/config.py full
4535 scripts/config.py unset MBEDTLS_SSL_CLI_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_sockets () {
4540 # Note, C99 compliance can also be tested with the sockets support disabled,
4541 # as that requires a POSIX platform (which isn't the same as C99).
4542 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004543 scripts/config.py full
4544 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4545 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4546 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4547}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004548
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004549component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004550 msg "build: default config with memory buffer allocator and backtrace enabled"
4551 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4552 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4553 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004554 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004555 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004556 make
4557
4558 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4559 make test
4560}
4561
4562component_test_memory_buffer_allocator () {
4563 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004564 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4565 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004566 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004567 make
4568
4569 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4570 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004571
4572 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4573 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004574 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004575}
4576
Gilles Peskine8f073122018-11-27 15:58:47 +01004577component_test_no_max_fragment_length () {
4578 # Run max fragment length tests with MFL disabled
4579 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004580 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004581 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004582 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004583
Gilles Peskine8f073122018-11-27 15:58:47 +01004584 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004585 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004586}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004587
Hanno Becker545ced42019-02-19 11:10:48 +00004588component_test_asan_remove_peer_certificate () {
4589 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004590 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Dave Rodgman17127e92023-12-14 16:42:48 +00004591 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004592 make
4593
4594 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4595 make test
4596
4597 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004598 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004599
4600 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004601 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004602
4603 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004604 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004605}
4606
Gilles Peskine8f073122018-11-27 15:58:47 +01004607component_test_no_max_fragment_length_small_ssl_out_content_len () {
4608 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004609 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4610 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4611 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004612 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004613 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004614
Gilles Peskine8f073122018-11-27 15:58:47 +01004615 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004616 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004617
4618 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004619 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004620}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004621
Darryl Greenaad82f92019-12-02 10:53:11 +00004622component_test_variable_ssl_in_out_buffer_len () {
4623 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4624 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004625 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004626 make
4627
4628 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4629 make test
4630
4631 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004632 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004633
4634 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004635 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004636}
4637
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004638component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004639 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004640 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004641
Dave Rodgman17127e92023-12-14 16:42:48 +00004642 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004643 make
4644
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004645 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004646 make test
4647
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004648 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004649 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004650
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004651 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004652 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004653}
4654
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004655component_test_ssl_alloc_buffer_and_mfl () {
4656 msg "build: default config with memory buffer allocator and MFL extension"
4657 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4658 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4659 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4660 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4661 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004662 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004663 make
4664
4665 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4666 make test
4667
4668 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 +02004669 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004670}
4671
Gilles Peskine636c26a2020-03-04 20:46:15 +01004672component_test_when_no_ciphersuites_have_mac () {
4673 msg "build: when no ciphersuites have MAC"
4674 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004675 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004676 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004677 make
4678
4679 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4680 make test
4681
4682 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004683 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004684}
4685
Raoul Strackxa4e86142020-06-15 17:03:13 +02004686component_test_no_date_time () {
4687 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4688 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004689 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004690 make
4691
4692 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4693 make test
4694}
4695
Gilles Peskine8f073122018-11-27 15:58:47 +01004696component_test_platform_calloc_macro () {
4697 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004698 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4699 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4700 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004701 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004702 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004703
Gilles Peskine8f073122018-11-27 15:58:47 +01004704 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4705 make test
4706}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004707
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004708component_test_malloc_0_null () {
4709 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004710 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004711 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 +02004712
4713 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4714 make test
4715
4716 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4717 # Just the calloc selftest. "make test" ran the others as part of the
4718 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004719 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004720
4721 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4722 # Run a subset of the tests. The choice is a balance between coverage
4723 # and time (including time indirectly wasted due to flaky tests).
4724 # The current choice is to skip tests whose description includes
4725 # "proxy", which is an approximation of skipping tests that use the
4726 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004727 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004728}
4729
Dave Rodgman6a08b682023-06-19 11:51:33 +01004730support_test_aesni() {
4731 # Check that gcc targets x86_64 (we can build AESNI), and check for
4732 # AESNI support on the host (we can run AESNI).
4733 #
4734 # The name of this function is possibly slightly misleading, but needs to align
4735 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004736 #
4737 # In principle 32-bit x86 can support AESNI, but our implementation does not
4738 # support 32-bit x86, so we check for x86-64.
4739 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004740 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4741 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004742 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004743}
4744
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004745component_test_aesni () { # ~ 60s
4746 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4747 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4748 #
4749 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4750 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4751 # exercise the plain C impl).
4752
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004753 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004754 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004755 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004756 scripts/config.py set MBEDTLS_HAVE_ASM
4757
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004758 # test the intrinsics implementation
4759 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004760 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004761 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004762 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004763 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004764
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004765 # test the asm implementation
4766 msg "AES tests, test assembly"
4767 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004768 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004769 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004770 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004771
4772 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004773 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004774 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004775 msg "AES tests, plain C"
4776 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004777 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004778 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004779 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004780 not grep -q "AES note: using AESNI" ./programs/test/selftest
4781 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004782
4783 # test the intrinsics implementation
4784 scripts/config.py set MBEDTLS_AESNI_C
4785 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4786 msg "AES tests, test AESNI only"
4787 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004788 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004789 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4790 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004791 grep -q "AES note: using AESNI" ./programs/test/selftest
4792 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004793}
4794
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004795component_test_sha3_variations() {
4796 msg "sha3 loop unroll variations"
4797
4798 # define minimal config sufficient to test SHA3
4799 cat > include/mbedtls/mbedtls_config.h << END
4800 #define MBEDTLS_SELF_TEST
4801 #define MBEDTLS_SHA3_C
4802END
4803
4804 msg "all loops unrolled"
4805 make clean
4806 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=1 -DMBEDTLS_SHA3_PI_UNROLL=1 -DMBEDTLS_SHA3_CHI_UNROLL=1 -DMBEDTLS_SHA3_RHO_UNROLL=1"
4807 ./tests/test_suite_shax
4808
4809 msg "all loops rolled up"
4810 make clean
4811 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=0 -DMBEDTLS_SHA3_PI_UNROLL=0 -DMBEDTLS_SHA3_CHI_UNROLL=0 -DMBEDTLS_SHA3_RHO_UNROLL=0"
4812 ./tests/test_suite_shax
4813}
4814
Jerry Yub6d39c22023-08-16 15:11:48 +08004815support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004816 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004817}
4818
4819component_test_aesni_m32 () { # ~ 60s
4820 # This tests are duplicated from component_test_aesni for i386 target
4821 #
4822 # AESNI intrinsic code supports i386 and assembly code does not support it.
4823
4824 msg "build: default config with different AES implementations"
4825 scripts/config.py set MBEDTLS_AESNI_C
4826 scripts/config.py set MBEDTLS_PADLOCK_C
4827 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4828 scripts/config.py set MBEDTLS_HAVE_ASM
4829
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004830 # test the intrinsics implementation with gcc
4831 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004832 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004833 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004834 # check that we built intrinsics - this should be used by default when supported by the compiler
4835 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4836 grep -q "AES note: using AESNI" ./programs/test/selftest
4837 grep -q "AES note: built-in implementation." ./programs/test/selftest
4838 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4839 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4840
4841 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004842 scripts/config.py unset MBEDTLS_PADLOCK_C
4843 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4844 msg "AES tests, test AESNI only"
4845 make clean
4846 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4847 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4848 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4849 grep -q "AES note: using AESNI" ./programs/test/selftest
4850 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4851 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4852 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4853}
4854
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004855support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004856 # clang >= 4 is required to build with target attributes
4857 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004858}
4859
4860component_test_aesni_m32_clang() {
4861
4862 scripts/config.py set MBEDTLS_AESNI_C
4863 scripts/config.py set MBEDTLS_PADLOCK_C
4864 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4865 scripts/config.py set MBEDTLS_HAVE_ASM
4866
4867 # test the intrinsics implementation with clang
4868 msg "AES tests, test intrinsics (clang)"
4869 make clean
4870 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4871 # check that we built intrinsics - this should be used by default when supported by the compiler
4872 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4873 grep -q "AES note: using AESNI" ./programs/test/selftest
4874 grep -q "AES note: built-in implementation." ./programs/test/selftest
4875 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4876 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4877}
4878
Jerry Yu193cbc02023-08-03 17:06:29 +08004879# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4880component_build_aes_aesce_armcc () {
4881 msg "Build: AESCE test on arm64 platform without plain C."
4882 scripts/config.py baremetal
4883
4884 # armc[56] don't support SHA-512 intrinsics
4885 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4886
4887 # Stop armclang warning about feature detection for A64_CRYPTO.
4888 # With this enabled, the library does build correctly under armclang,
4889 # but in baremetal builds (as tested here), feature detection is
4890 # unavailable, and the user is notified via a #warning. So enabling
4891 # this feature would prevent us from building with -Werror on
4892 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004893 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004894 scripts/config.py set MBEDTLS_HAVE_ASM
4895
4896 msg "AESCE, build with default configuration."
4897 scripts/config.py set MBEDTLS_AESCE_C
4898 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4899 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4900
4901 msg "AESCE, build AESCE only"
4902 scripts/config.py set MBEDTLS_AESCE_C
4903 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4904 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4905}
4906
Dave Rodgman0c584032023-10-08 12:26:54 +01004907support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004908 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004909 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004910}
4911
4912component_build_aes_armce () {
4913 # Test variations of AES with Armv8 crypto extensions
4914 scripts/config.py set MBEDTLS_AESCE_C
4915 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4916
4917 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004918 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004919
4920 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4921 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4922
4923 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4924 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4925
Dave Rodgman5e419372023-10-23 15:30:20 +01004926 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004927
Dave Rodgman5e419372023-10-23 15:30:20 +01004928 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4929 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004930
Dave Rodgman5e419372023-10-23 15:30:20 +01004931 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4932 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004933
Dave Rodgman5e419372023-10-23 15:30:20 +01004934 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4935 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004936
4937 # test for presence of AES instructions
4938 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4939 msg "clang, test A32 crypto instructions built"
4940 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4941 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4942 msg "clang, test T32 crypto instructions built"
4943 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4944 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4945 msg "clang, test aarch64 crypto instructions built"
4946 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4947 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4948
4949 # test for absence of AES instructions
4950 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4951 scripts/config.py unset MBEDTLS_AESCE_C
4952 msg "clang, test A32 crypto instructions not built"
4953 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4954 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4955 msg "clang, test T32 crypto instructions not built"
4956 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4957 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4958 msg "clang, test aarch64 crypto instructions not built"
4959 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4960 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004961}
4962
Dave Rodgman9ed18532023-10-05 00:06:47 +01004963support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004964 # clang >= 4 is required to build with SHA extensions
4965 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004966}
4967
Dave Rodgmand9e80832023-10-04 17:17:46 +01004968component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004969 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004970
4971
4972 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004973 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004974 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4975 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4976 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4977 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4978 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004979
Dave Rodgmand9e80832023-10-04 17:17:46 +01004980
Dave Rodgman94a634d2023-10-10 12:59:29 +01004981 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004982 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004983 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4984 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4985 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004986
Dave Rodgman5b89c552023-10-10 14:59:02 +01004987 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004988 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4989 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4990 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004991
Dave Rodgmancd654002023-10-05 09:40:07 +01004992
Dave Rodgman94a634d2023-10-10 12:59:29 +01004993 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004994 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004995 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4996 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4997 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4998 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4999 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005000
Dave Rodgmancd654002023-10-05 09:40:07 +01005001
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005002 # examine the disassembly for presence of SHA instructions
5003 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5004 scripts/config.py set ${opt}
5005 msg "${opt} clang, test A32 crypto instructions built"
5006 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5007 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5008
5009 msg "${opt} clang, test T32 crypto instructions built"
5010 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5011 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5012
5013 msg "${opt} clang, test aarch64 crypto instructions built"
5014 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5015 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5016 scripts/config.py unset ${opt}
5017 done
5018
5019
5020 # examine the disassembly for absence of SHA instructions
5021 msg "clang, test A32 crypto instructions not built"
5022 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5023 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5024
5025 msg "clang, test T32 crypto instructions not built"
5026 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5027 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5028
5029 msg "clang, test aarch64 crypto instructions not built"
5030 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5031 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005032}
5033
Jerry Yuc935aa62023-08-03 17:08:27 +08005034# For timebeing, no VIA Padlock platform available.
5035component_build_aes_via_padlock () {
5036
5037 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005038 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005039 scripts/config.py set MBEDTLS_PADLOCK_C
5040 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005041 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005042 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005043
5044}
5045
5046support_build_aes_via_padlock_only () {
5047 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5048 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5049 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5050}
5051
Jerry Yu193cbc02023-08-03 17:06:29 +08005052support_build_aes_aesce_armcc () {
5053 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005054}
5055
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005056component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005057 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005058 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005059 scripts/config.py unset MBEDTLS_PADLOCK_C
5060
Dave Rodgmand8d64512023-12-19 12:20:21 +00005061 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005062
5063 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5064 make test
5065}
5066
5067component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5068 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5069 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005070 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5071 scripts/config.py unset MBEDTLS_PADLOCK_C
5072
Hanno Becker83ebf782017-07-07 12:29:15 +01005073 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005074
5075 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005076 make test
5077}
Gilles Peskine8f073122018-11-27 15:58:47 +01005078
Hanno Becker83ebf782017-07-07 12:29:15 +01005079component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005080 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5081 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5082 scripts/config.py unset MBEDTLS_PADLOCK_C
5083 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005084 scripts/config.py unset MBEDTLS_AESCE_C
5085
Dave Rodgmand8d64512023-12-19 12:20:21 +00005086 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005087
5088 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005089 make test
5090
5091 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5092 programs/test/selftest
5093}
5094
Matthias Schulz0767fda2024-02-07 10:46:28 +01005095component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005096 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5097 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005098 scripts/config.py unset MBEDTLS_PADLOCK_C
5099 scripts/config.py unset MBEDTLS_AESNI_C
5100 scripts/config.py unset MBEDTLS_AESCE_C
5101
5102 make CFLAGS='-O2 -Werror -Wall -Wextra'
5103
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005104 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005105 make test
5106}
5107
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005108component_test_aes_fewer_tables () {
5109 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005110 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005111 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005112
Gilles Peskine7c652162017-12-11 00:01:40 +01005113 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005114 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005115}
5116
5117component_test_aes_rom_tables () {
5118 msg "build: default config with AES_ROM_TABLES enabled"
5119 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005120 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005121
5122 msg "test: AES_ROM_TABLES"
5123 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005124}
5125
Gilles Peskine14c3c062018-01-29 21:25:12 +01005126component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005127 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5128 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5129 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005130 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005131
Gilles Peskine8f073122018-11-27 15:58:47 +01005132 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5133 make test
5134}
5135
Yanray Wang49cd4b52023-11-10 11:58:37 +08005136# helper for common_block_cipher_no_decrypt() which:
5137# - enable/disable the list of config options passed from -s/-u respectively.
5138# - build
5139# - test for tests_suite_xxx
5140# - selftest
5141#
5142# Usage: helper_block_cipher_no_decrypt_build_test
5143# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5144# Options: -s set_opts the list of config options to enable
5145# -u unset_opts the list of config options to disable
5146# -c cflags the list of options passed to CFLAGS
5147# -l ldflags the list of options passed to LDFLAGS
5148helper_block_cipher_no_decrypt_build_test () {
5149 while [ $# -gt 0 ]; do
5150 case "$1" in
5151 -s)
5152 shift; local set_opts="$1";;
5153 -u)
5154 shift; local unset_opts="$1";;
5155 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005156 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005157 -l)
5158 shift; local ldflags="$1";;
5159 esac
5160 shift
5161 done
5162 set_opts="${set_opts:-}"
5163 unset_opts="${unset_opts:-}"
5164 cflags="${cflags:-}"
5165 ldflags="${ldflags:-}"
5166
Yanray Wangb2d6e522023-11-13 16:57:47 +08005167 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5168 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005169
5170 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5171 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005172 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005173
5174 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5175 not grep mbedtls_aes_setkey_dec library/aes.o
5176 not grep mbedtls_aria_setkey_dec library/aria.o
5177 not grep mbedtls_camellia_setkey_dec library/camellia.o
5178 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5179 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005180 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5181 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005182
5183 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5184 make test
5185
5186 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5187 programs/test/selftest
5188}
5189
5190# This is a common configuration function used in:
5191# - component_test_block_cipher_no_decrypt_aesni_legacy()
5192# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5193# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5194# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5195# on x86.
5196common_block_cipher_no_decrypt () {
5197 # test AESNI intrinsics
5198 helper_block_cipher_no_decrypt_build_test \
5199 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005200 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005201
5202 # test AESNI assembly
5203 helper_block_cipher_no_decrypt_build_test \
5204 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005205 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005206
5207 # test AES C implementation
5208 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005209 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005210
5211 # test AESNI intrinsics for i386 target
5212 helper_block_cipher_no_decrypt_build_test \
5213 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005214 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005215 -l "-m32"
5216}
5217
Yanray Wang3ae11992023-11-13 17:32:09 +08005218# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5219# usage: 0: no PSA crypto configuration
5220# 1: use PSA crypto configuration
5221config_block_cipher_no_decrypt () {
5222 use_psa=$1
5223
Yanray Wang66111392023-10-31 18:54:54 +08005224 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005225 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5226 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005227 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005228 scripts/config.py unset MBEDTLS_NIST_KW_C
5229
Yanray Wang3ae11992023-11-13 17:32:09 +08005230 if [ "$use_psa" -eq 1 ]; then
5231 # Enable support for cryptographic mechanisms through the PSA API.
5232 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5233 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5234 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5235 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5236 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5237 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5238 fi
5239}
5240
5241component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005242 # This consistently causes an llvm crash on clang 3.8, so use gcc
5243 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005244 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005245 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005246}
5247
Yanray Wangf1496402023-11-01 18:55:13 +08005248component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005249 # This consistently causes an llvm crash on clang 3.8, so use gcc
5250 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005251 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005252 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005253}
5254
Yanray Wang66111392023-10-31 18:54:54 +08005255support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005256 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005257}
5258
Yanray Wang66111392023-10-31 18:54:54 +08005259component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005260 scripts/config.py baremetal
5261
5262 # armc[56] don't support SHA-512 intrinsics
5263 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5264
5265 # Stop armclang warning about feature detection for A64_CRYPTO.
5266 # With this enabled, the library does build correctly under armclang,
5267 # but in baremetal builds (as tested here), feature detection is
5268 # unavailable, and the user is notified via a #warning. So enabling
5269 # this feature would prevent us from building with -Werror on
5270 # armclang. Tracked in #7198.
5271 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5272 scripts/config.py set MBEDTLS_HAVE_ASM
5273
Yanray Wang3ae11992023-11-13 17:32:09 +08005274 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005275
5276 # test AESCE baremetal build
5277 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005278 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005279 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005280
Yanray Wangef1b04d2023-09-08 11:09:26 +08005281 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5282 not grep mbedtls_aes_setkey_dec library/aes.o
5283 not grep mbedtls_aria_setkey_dec library/aria.o
5284 not grep mbedtls_camellia_setkey_dec library/camellia.o
5285 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5286 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005287 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005288 not grep mbedtls_aesce_inverse_key library/aesce.o
5289 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005290}
5291
Gilles Peskine592f5912019-10-07 18:49:32 +02005292component_test_ctr_drbg_aes_256_sha_256 () {
5293 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5294 scripts/config.py full
5295 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5296 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005297 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005298 make
5299
5300 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5301 make test
5302}
5303
5304component_test_ctr_drbg_aes_128_sha_512 () {
5305 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005306 scripts/config.py full
5307 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5308 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
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 (ASan build)"
5313 make test
5314}
5315
5316component_test_ctr_drbg_aes_128_sha_256 () {
5317 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005318 scripts/config.py full
5319 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5320 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5321 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005322 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005323 make
5324
5325 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5326 make test
5327}
5328
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005329component_test_se_default () {
5330 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005331 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005332 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005333
5334 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5335 make test
5336}
5337
Steven Cooremand57203d2020-07-16 20:28:59 +02005338component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005339 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005340 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005341 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005342 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5343 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005344 loc_cflags="${loc_cflags} -I../tests/include -O2"
5345
Gilles Peskine21570cf2023-12-22 11:49:50 +01005346 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005347
Gilles Peskine1997f302023-07-26 18:45:20 +02005348 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005349 make test
5350}
5351
Gilles Peskine8f073122018-11-27 15:58:47 +01005352component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005353 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005354 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005355 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005356 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005357}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005358
Gilles Peskinecf740502019-07-03 20:43:05 +02005359component_test_cmake_shared () {
5360 msg "build/test: cmake shared" # ~ 2min
5361 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5362 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005363 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005364 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005365 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005366}
5367
Gilles Peskineec10bf12019-09-20 19:56:06 +02005368test_build_opt () {
5369 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005370 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005371 for opt in "$@"; do
5372 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005373 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005374 # We're confident enough in compilers to not run _all_ the tests,
5375 # but at least run the unit tests. In particular, runs with
5376 # optimizations use inline assembly whereas runs with -O0
5377 # skip inline assembly.
5378 make test # ~30s
5379 make clean
5380 done
5381}
5382
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005383# For FreeBSD we invoke the function by name so this condition is added
5384# to disable the existing test_clang_opt function for linux.
5385if [[ $(uname) != "Linux" ]]; then
5386 component_test_clang_opt () {
5387 scripts/config.py full
5388 test_build_opt 'full config' clang -O0 -Os -O2
5389 }
5390fi
5391
5392component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005393 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005394 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005395}
5396support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005397 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005398}
5399
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005400component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005401 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005402 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005403}
5404support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005405 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005406}
5407
5408component_test_gcc_latest_opt () {
5409 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005410 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005411}
5412support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005413 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005414}
5415
5416component_test_gcc_earliest_opt () {
5417 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005418 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005419}
5420support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005421 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005422}
5423
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005424component_build_mbedtls_config_file () {
5425 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005426 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005427 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005428 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005429 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005430 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5431 make clean
5432
5433 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5434 # In the user config, disable one feature (for simplicity, pick a feature
5435 # that nothing else depends on).
5436 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005437 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005438 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5439
5440 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005441}
5442
Gilles Peskine7d904e72022-04-07 21:59:14 +02005443component_build_psa_config_file () {
5444 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5445 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5446 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5447 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5448 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005449 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005450 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5451 make clean
5452
5453 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5454 # In the user config, disable one feature, which will reflect on the
5455 # mbedtls configuration so we can query it with query_compile_time_config.
5456 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5457 scripts/config.py unset MBEDTLS_CMAC_C
5458 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5459 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5460
5461 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005462}
5463
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005464component_build_psa_alt_headers () {
5465 msg "build: make with PSA alt headers" # ~20s
5466
5467 # Generate alternative versions of the substitutable headers with the
5468 # same content except different include guards.
5469 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5470
5471 # Build the library and some programs.
5472 # Don't build the fuzzers to avoid having to go through hoops to set
5473 # a correct include path for programs/fuzz/Makefile.
5474 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
5475 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\"'"
5476
5477 # Check that we're getting the alternative include guards and not the
5478 # original include guards.
5479 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5480 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5481 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5482 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5483}
5484
Dave Rodgman852de3c2023-12-14 14:46:45 +00005485component_test_m32_no_asm () {
5486 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005487 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005488 #
5489 # Note that we require gcc, because clang Asan builds fail to link for
5490 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005491 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005492 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005493 scripts/config.py unset MBEDTLS_HAVE_ASM
5494 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005495 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005496 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005497
Dave Rodgman852de3c2023-12-14 14:46:45 +00005498 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005499 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005500}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005501support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005502 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005503 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005504 *) false;;
5505 esac
5506}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005507
Gilles Peskineff0aee02021-10-05 09:36:03 +02005508component_test_m32_o2 () {
5509 # Build with optimization, to use the i386 specific inline assembly
5510 # and go faster for tests.
5511 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005512 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005513 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005514 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005515
Gilles Peskineff0aee02021-10-05 09:36:03 +02005516 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005517 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005518
Gilles Peskineff0aee02021-10-05 09:36:03 +02005519 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005520 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005521}
Gilles Peskinecf522222021-10-07 19:25:29 +02005522support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005523 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005524}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005525
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005526component_test_m32_everest () {
5527 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005528 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005529 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005530 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005531
5532 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5533 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005534
5535 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005536 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005537
5538 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5539 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005540 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005541}
5542support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005543 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005544}
5545
Gilles Peskine8f073122018-11-27 15:58:47 +01005546component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005547 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005548 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005549 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005550
5551 msg "test: 64-bit ILP32, make, gcc"
5552 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005553}
Gilles Peskine878cf602019-01-06 20:50:38 +00005554support_test_mx32 () {
5555 case $(uname -m) in
5556 amd64|x86_64) true;;
5557 *) false;;
5558 esac
5559}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005560
Peter Kolbus60c6da22018-12-27 06:59:04 -06005561component_test_min_mpi_window_size () {
5562 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005563 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005564 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005565 make
5566
5567 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5568 make test
5569}
5570
Gilles Peskine8f073122018-11-27 15:58:47 +01005571component_test_have_int32 () {
5572 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005573 scripts/config.py unset MBEDTLS_HAVE_ASM
5574 scripts/config.py unset MBEDTLS_AESNI_C
5575 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005576 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005577 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005578
Gilles Peskine8f073122018-11-27 15:58:47 +01005579 msg "test: gcc, force 32-bit bignum limbs"
5580 make test
5581}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005582
Gilles Peskine8f073122018-11-27 15:58:47 +01005583component_test_have_int64 () {
5584 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005585 scripts/config.py unset MBEDTLS_HAVE_ASM
5586 scripts/config.py unset MBEDTLS_AESNI_C
5587 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005588 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005589 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005590
Gilles Peskine8f073122018-11-27 15:58:47 +01005591 msg "test: gcc, force 64-bit bignum limbs"
5592 make test
5593}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005594
Gabor Mezeie256cc12023-07-26 17:28:48 +02005595component_test_have_int32_cmake_new_bignum () {
5596 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5597 scripts/config.py unset MBEDTLS_HAVE_ASM
5598 scripts/config.py unset MBEDTLS_AESNI_C
5599 scripts/config.py unset MBEDTLS_PADLOCK_C
5600 scripts/config.py unset MBEDTLS_AESCE_C
5601 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005602 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005603 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005604
5605 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5606 make test
5607}
5608
Gilles Peskine8f073122018-11-27 15:58:47 +01005609component_test_no_udbl_division () {
5610 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005611 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005612 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005613 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005614
Gilles Peskine8f073122018-11-27 15:58:47 +01005615 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5616 make test
5617}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005618
Gilles Peskine8f073122018-11-27 15:58:47 +01005619component_test_no_64bit_multiplication () {
5620 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005621 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005622 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005623 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005624
Gilles Peskine8f073122018-11-27 15:58:47 +01005625 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5626 make test
5627}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005628
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005629component_test_no_strings () {
5630 msg "build: no strings" # ~10s
5631 scripts/config.py full
5632 # Disable options that activate a large amount of string constants.
5633 scripts/config.py unset MBEDTLS_DEBUG_C
5634 scripts/config.py unset MBEDTLS_ERROR_C
5635 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5636 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005637 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005638
5639 msg "test: no strings" # ~ 10s
5640 make test
5641}
5642
Hanno Beckerc5722d12020-10-09 11:10:42 +01005643component_test_no_x509_info () {
5644 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5645 scripts/config.pl full
5646 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5647 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005648 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005649
5650 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5651 make test
5652
5653 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005654 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005655}
5656
Gilles Peskine8f073122018-11-27 15:58:47 +01005657component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005658 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005659 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005660 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 +02005661
Gilles Peskinee36fe812021-09-01 20:00:33 +02005662 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005663 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005664}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005665
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005666component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005667 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005668 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005669 # Build for a target platform that's close to what Debian uses
5670 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005671 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005672 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005673 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005674 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'
5675
Gilles Peskinee36fe812021-09-01 20:00:33 +02005676 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005677 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005678}
5679support_build_arm_linux_gnueabi_gcc_arm5vte () {
5680 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5681}
5682
5683component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005684 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005685 scripts/config.py baremetal
5686 # This is an imperfect substitute for
5687 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005688 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005689 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 +02005690
Gilles Peskinee36fe812021-09-01 20:00:33 +02005691 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005692 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005693}
5694
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005695component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005696 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5697 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005698 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 +02005699
Gilles Peskinee36fe812021-09-01 20:00:33 +02005700 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005701 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005702 for lib in library/*.a; do
5703 echo "$lib:"
5704 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5705 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005706}
5707
Gilles Peskine8f073122018-11-27 15:58:47 +01005708component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005709 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005710 scripts/config.py baremetal
5711 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005712 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 +01005713 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005714 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005715}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005716
Gilles Peskine8f073122018-11-27 15:58:47 +01005717component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005718 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005719 scripts/config.py baremetal
5720 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005721 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 +01005722 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005723 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005724}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005725
Dave Rodgman8c315f22023-06-02 10:26:24 -04005726component_build_arm_clang_thumb () {
5727 # ~ 30s
5728
5729 scripts/config.py baremetal
5730
5731 msg "build: clang thumb 2, make"
5732 make clean
5733 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5734
5735 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5736 msg "build: clang thumb 1 -O0, make"
5737 make clean
5738 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5739
5740 msg "build: clang thumb 1 -Os, make"
5741 make clean
5742 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5743}
5744
Gilles Peskine8f073122018-11-27 15:58:47 +01005745component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005746 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005747 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005748 # armc[56] don't support SHA-512 intrinsics
5749 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005750
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005751 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5752 scripts/config.py unset MBEDTLS_AESCE_C
5753
Dave Rodgman0fddf822023-03-02 15:32:12 +00005754 # Stop armclang warning about feature detection for A64_CRYPTO.
5755 # With this enabled, the library does build correctly under armclang,
5756 # but in baremetal builds (as tested here), feature detection is
5757 # unavailable, and the user is notified via a #warning. So enabling
5758 # this feature would prevent us from building with -Werror on
5759 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005760 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005761
Hanno Beckerf0762e92022-07-15 12:08:19 +01005762 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005763
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005764 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005765
5766 msg "size: ARM Compiler 5"
5767 "$ARMC5_FROMELF" -z library/*.o
5768
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005769 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005770
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005771 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005772 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005773
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005774 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005775 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5776
5777 # ARM Compiler 6 - Target ARMv7-M+DSP
5778 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005779
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005780 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005781 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005782
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005783 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005784 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005785
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005786 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5787 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5788
Dave Rodgman99318e62023-05-24 12:27:42 +01005789 # ARM Compiler 6 - Target Cortex-M0
5790 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005791
5792 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5793 #
5794 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5795 # that we have in our CI
5796 scripts/config.py set MBEDTLS_AESCE_C
5797 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005798}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005799
Pengyu Lvdf070032023-02-24 16:03:31 +08005800support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005801 armc5_cc="$ARMC5_BIN_DIR/armcc"
5802 armc6_cc="$ARMC6_BIN_DIR/armclang"
5803 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005804}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005805
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005806component_test_tls13_only () {
5807 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3, without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005808 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005809 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005810 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5811
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005812 msg "test: TLS 1.3 only, all key exchange modes enabled"
5813 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005814
Ronald Cronc3f43b62022-10-17 17:35:32 +02005815 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5816 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005817}
5818
Ronald Cronc3f43b62022-10-17 17:35:32 +02005819component_test_tls13_only_psk () {
5820 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5821 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5822 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5823 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005824 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005825 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5826 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5827 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5828 scripts/config.py unset MBEDTLS_ECDSA_C
5829 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005830 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005831 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005832 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5833
Ronald Cronc3f43b62022-10-17 17:35:32 +02005834 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5835 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005836
Ronald Cronc3f43b62022-10-17 17:35:32 +02005837 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5838 tests/ssl-opt.sh
5839}
5840
5841component_test_tls13_only_ephemeral () {
5842 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5843 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5844 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005845 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005846 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5847
5848 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5849 cd tests; ./test_suite_ssl; cd ..
5850
5851 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5852 tests/ssl-opt.sh
5853}
5854
Przemek Stekiela01c2422023-06-13 10:46:48 +02005855component_test_tls13_only_ephemeral_ffdh () {
5856 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5857 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5858 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5859 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005860 scripts/config.py unset MBEDTLS_ECDH_C
5861
Przemek Stekiela01c2422023-06-13 10:46:48 +02005862 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5863
5864 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5865 cd tests; ./test_suite_ssl; cd ..
5866
5867 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5868 tests/ssl-opt.sh
5869}
5870
Ronald Cronc3f43b62022-10-17 17:35:32 +02005871component_test_tls13_only_psk_ephemeral () {
5872 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5873 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5874 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5875 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5876 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5877 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5878 scripts/config.py unset MBEDTLS_ECDSA_C
5879 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005880 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005881 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005882 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5883
5884 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5885 cd tests; ./test_suite_ssl; cd ..
5886
5887 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5888 tests/ssl-opt.sh
5889}
5890
Przemek Stekiela01c2422023-06-13 10:46:48 +02005891component_test_tls13_only_psk_ephemeral_ffdh () {
5892 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5893 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5894 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5895 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5896 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5897 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5898 scripts/config.py unset MBEDTLS_ECDSA_C
5899 scripts/config.py unset MBEDTLS_PKCS1_V21
5900 scripts/config.py unset MBEDTLS_PKCS7_C
5901 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005902 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005903 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5904
5905 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5906 cd tests; ./test_suite_ssl; cd ..
5907
5908 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5909 tests/ssl-opt.sh
5910}
5911
Ronald Cronc3f43b62022-10-17 17:35:32 +02005912component_test_tls13_only_psk_all () {
5913 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5914 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5915 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5916 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5917 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5918 scripts/config.py unset MBEDTLS_ECDSA_C
5919 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005920 scripts/config.py unset MBEDTLS_PKCS7_C
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, PSK and PSK ephemeral key exchange modes"
5925 cd tests; ./test_suite_ssl; cd ..
5926
5927 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5928 tests/ssl-opt.sh
5929}
5930
5931component_test_tls13_only_ephemeral_all () {
5932 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5933 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005934 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005935 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5936
5937 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5938 cd tests; ./test_suite_ssl; cd ..
5939
5940 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5941 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005942}
5943
Ronald Cron6f135e12021-12-08 16:57:54 +01005944component_test_tls13 () {
5945 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5946 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005947 scripts/config.py set MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5948 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005949 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005950 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005951 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005952 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005953 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005954 msg "ssl-opt.sh (TLS 1.3)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005955 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005956}
5957
Ronald Cron6f135e12021-12-08 16:57:54 +01005958component_test_tls13_no_compatibility_mode () {
5959 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5960 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005961 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5962 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005963 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005964 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005965 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005966 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005967 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005968 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005969 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005970}
5971
Gilles Peskine8f073122018-11-27 15:58:47 +01005972component_build_mingw () {
5973 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005974 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 +00005975
Gilles Peskine8f073122018-11-27 15:58:47 +01005976 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005977 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 +01005978 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005979
Gilles Peskine8f073122018-11-27 15:58:47 +01005980 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005981 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
5982 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 +01005983 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005984
Pengyu Lv158eead2023-10-19 11:27:05 +08005985 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005986 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005987 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 +01005988 make WINDOWS_BUILD=1 clean
5989}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005990support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005991 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5992 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005993 *) true;;
5994 esac
5995}
Simon Butcher91aef332016-11-17 09:20:50 +00005996
Gilles Peskine8f073122018-11-27 15:58:47 +01005997component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005998 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005999 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006000 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6001 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006002
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006003 msg "test: main suites (MSan)" # ~ 10s
6004 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006005
Gilles Peskine6848d172023-11-02 19:58:03 +01006006 msg "test: metatests (MSan)"
6007 tests/scripts/run-metatests.sh any msan
6008
Gilles Peskine82b27272019-06-14 18:27:03 +02006009 msg "program demos (MSan)" # ~20s
6010 tests/scripts/run_demos.py
6011
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006012 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006013 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006014
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006015 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006016
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006017 if [ "$MEMORY" -gt 0 ]; then
6018 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006019 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006020 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006021}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006022
Bence Szépkúti0354d042023-12-06 16:14:37 +01006023component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006024 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006025 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006026 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6027 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006028
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006029 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006030 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006031
Gilles Peskine636c26a2020-03-04 20:46:15 +01006032 # Optional parts (slow; currently broken on OS X because programs don't
6033 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006034 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006035 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006036 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006037 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006038 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006039
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006040 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006041 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006042 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006043 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006044
6045 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006046 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006047 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006048 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006049}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006050
Bence Szépkúti0354d042023-12-06 16:14:37 +01006051component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006052 msg "build: Release, full (clang)"
6053 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6054 scripts/config.py full
6055 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6056 make
6057
6058 msg "test: main suites, Valgrind (full config)"
6059 make memcheck
6060}
6061
Paul Elliott62dc3922021-11-25 17:29:40 +00006062support_test_cmake_out_of_source () {
6063 distrib_id=""
6064 distrib_ver=""
6065 distrib_ver_minor=""
6066 distrib_ver_major=""
6067
6068 # Attempt to parse lsb-release to find out distribution and version. If not
6069 # found this should fail safe (test is supported).
6070 if [[ -f /etc/lsb-release ]]; then
6071
6072 while read -r lsb_line; do
6073 case "$lsb_line" in
6074 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6075 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6076 esac
6077 done < /etc/lsb-release
6078
6079 distrib_ver_major="${distrib_ver%%.*}"
6080 distrib_ver="${distrib_ver#*.}"
6081 distrib_ver_minor="${distrib_ver%%.*}"
6082 fi
6083
6084 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6085 # processor (as the CI does) can create a race condition whereby the build
6086 # fails to see a generated file, despite that file actually having been
6087 # generated. This problem appears to go away with 18.04 or newer, so make
6088 # the out of source tests unsupported on Ubuntu 16.04.
6089 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6090}
6091
Gilles Peskine8f073122018-11-27 15:58:47 +01006092component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006093 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006094 # generates
6095 make neat
6096
Gilles Peskine8f073122018-11-27 15:58:47 +01006097 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006098 MBEDTLS_ROOT_DIR="$PWD"
6099 mkdir "$OUT_OF_SOURCE_DIR"
6100 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006101 # Note: Explicitly generate files as these are turned off in releases
6102 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006103 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006104
Gilles Peskine8f073122018-11-27 15:58:47 +01006105 msg "test: cmake 'out-of-source' build"
6106 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006107 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006108 # Also ensure that there are no error messages such as
6109 # "No such file or directory", which would indicate that some required
6110 # file is missing (ssl-opt.sh tolerates the absence of some files so
6111 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006112 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006113 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006114 cat ssl-opt.err >&2
6115 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006116 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006117 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006118 cd "$MBEDTLS_ROOT_DIR"
6119 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006120}
Andres AGdc192212016-08-31 17:33:13 +01006121
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006122component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006123 # Remove existing generated files so that we use the ones CMake
6124 # generates
6125 make neat
6126
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006127 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006128 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006129 # Note: Explicitly generate files as these are turned off in releases
6130 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006131 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006132 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006133}
Gilles Peskinea3000992022-02-04 00:21:12 +01006134support_test_cmake_as_subdirectory () {
6135 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006136}
6137
Chris Kayd259e342021-03-25 16:03:25 +00006138component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006139 # Remove existing generated files so that we use the ones CMake
6140 # generates
6141 make neat
6142
Chris Kayd259e342021-03-25 16:03:25 +00006143 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006144 cd programs/test/cmake_package
6145 cmake .
6146 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006147 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006148}
Gilles Peskinea3000992022-02-04 00:21:12 +01006149support_test_cmake_as_package () {
6150 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006151}
6152
6153component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006154 # Remove existing generated files so that we use the ones CMake
6155 # generates
6156 make neat
6157
Chris Kayd259e342021-03-25 16:03:25 +00006158 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006159 cd programs/test/cmake_package_install
6160 cmake .
6161 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006162 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006163}
Gilles Peskinea3000992022-02-04 00:21:12 +01006164support_test_cmake_as_package_install () {
6165 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006166}
6167
David Horstmann20550e32023-01-12 14:17:01 +00006168component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006169 # Make a copy of config file to use for the in-tree test
6170 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006171
6172 MBEDTLS_ROOT_DIR="$PWD"
6173 mkdir "$OUT_OF_SOURCE_DIR"
6174 cd "$OUT_OF_SOURCE_DIR"
6175
David Horstmann969c1452023-01-31 10:34:44 +00006176 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006177 cmake "$MBEDTLS_ROOT_DIR"
6178 make
6179
6180 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6181 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006182 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006183 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6184 make
6185
6186 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6187 # In the user config, disable one feature (for simplicity, pick a feature
6188 # that nothing else depends on).
6189 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6190
6191 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6192 make
6193 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6194
6195 rm -f user_config.h full_config.h
6196
6197 cd "$MBEDTLS_ROOT_DIR"
6198 rm -rf "$OUT_OF_SOURCE_DIR"
6199
6200 # Now repeat the test for an in-tree build:
6201
David Horstmann969c1452023-01-31 10:34:44 +00006202 # Restore config for the in-tree test
6203 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006204
David Horstmann969c1452023-01-31 10:34:44 +00006205 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006206 cmake .
6207 make
6208
6209 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6210 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006211 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006212 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6213 make
6214
6215 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6216 # In the user config, disable one feature (for simplicity, pick a feature
6217 # that nothing else depends on).
6218 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6219
6220 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6221 make
6222 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6223
6224 rm -f user_config.h full_config.h
6225}
6226support_build_cmake_custom_config_file () {
6227 support_test_cmake_out_of_source
6228}
6229
6230
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006231component_build_zeroize_checks () {
6232 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6233
6234 scripts/config.py full
6235
6236 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006237 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 +01006238}
6239
6240
Gilles Peskine8f073122018-11-27 15:58:47 +01006241component_test_zeroize () {
6242 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6243 # different combinations of compilers and optimization flags by using an
6244 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6245 # system in all cases that the script fails, so we must manually search the
6246 # output to check whether the pass string is present and no failure strings
6247 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006248
Gilles Peskine4976e822019-01-06 19:52:22 +00006249 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6250 # about a spurious message if Gdb tries and fails, so suppress that.
6251 gdb_disable_aslr=
6252 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6253 gdb_disable_aslr='set disable-randomization off'
6254 fi
6255
Gilles Peskine8f073122018-11-27 15:58:47 +01006256 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006257 for compiler in clang gcc; do
6258 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6259 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006260 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6261 grep "The buffer was correctly zeroized" test_zeroize.log
6262 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006263 rm -f test_zeroize.log
6264 make clean
6265 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006266 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006267}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006268
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006269component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006270 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006271 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006272 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006273
6274 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006275 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006276}
6277
6278support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006279 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006280 ver="$(cmake --version)"
6281 ver="${ver#cmake version }"
6282 ver_major="${ver%%.*}"
6283
6284 ver="${ver#*.}"
6285 ver_minor="${ver%%.*}"
6286
6287 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006288}
6289
Gilles Peskinec848d222022-12-09 12:23:35 +01006290component_check_code_style () {
6291 msg "Check C code style"
6292 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006293}
6294
Gilles Peskinec848d222022-12-09 12:23:35 +01006295support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006296 case $(uncrustify --version) in
6297 *0.75.1*) true;;
6298 *) false;;
6299 esac
6300}
6301
Gilles Peskine8f073122018-11-27 15:58:47 +01006302component_check_python_files () {
6303 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006304 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006305}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006306
Joe Subbianid614c0b2021-07-29 11:18:29 +01006307component_check_test_helpers () {
6308 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006309 # unittest writes out mundane stuff like number or tests run on stderr.
6310 # Our convention is to reserve stderr for actual errors, and write
6311 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006312 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006313
Joe Subbiania25ffab2021-08-06 09:41:27 +01006314 msg "unit test: translate_ciphers.py"
6315 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006316}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006317
Jerry Yud767cc42023-03-31 15:03:55 +08006318
Gilles Peskine192c72f2017-12-21 15:59:21 +01006319################################################################
6320#### Termination
6321################################################################
6322
Gilles Peskine8f073122018-11-27 15:58:47 +01006323post_report () {
6324 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006325 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006326
Gilles Peskine8f073122018-11-27 15:58:47 +01006327 final_report
6328}
6329
6330
6331
6332################################################################
6333#### Run all the things
6334################################################################
6335
Gilles Peskine5d996822020-03-28 21:09:21 +01006336# Function invoked by --error-test to test error reporting.
6337pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006338 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006339 if [ $KEEP_GOING -ne 0 ]; then
6340 echo "Expect three failing commands."
6341 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006342 # If the component doesn't run in a subshell, changing error_test_i to an
6343 # invalid integer will cause an error in the loop that runs this function.
6344 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006345 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006346 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006347 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006348 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006349 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006350 make unknown_target
6351 false "this should not be executed"
6352}
6353
Gilles Peskinee48351a2018-11-27 16:06:30 +01006354# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006355run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006356 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006357 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006358
6359 # Unconditionally create a seedfile that's sufficiently long.
6360 # Do this before each component, because a previous component may
6361 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006362 local dd_cmd
6363 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6364 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006365 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006366 esac
6367 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006368
Gilles Peskineec135542021-08-02 23:14:03 +02006369 # Run the component in a subshell, with error trapping and output
6370 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006371 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006372 # We want to keep running if the subshell fails, so 'set -e' must
6373 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006374 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006375 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006376 (
6377 if [ $QUIET -eq 1 ]; then
6378 # msg() will be silenced, so just print the component name here.
6379 echo "${current_component#component_}"
6380 exec >/dev/null
6381 fi
6382 if [ $KEEP_GOING -eq 1 ]; then
6383 # Keep "set -e" off, and run an ERR trap instead to record failures.
6384 set -E
6385 trap err_trap ERR
6386 fi
6387 # The next line is what runs the component
6388 "$@"
6389 if [ $KEEP_GOING -eq 1 ]; then
6390 trap - ERR
6391 exit $last_failure_status
6392 fi
6393 )
6394 component_status=$?
6395 if [ $KEEP_GOING -eq 1 ]; then
6396 set -e
6397 if [ $component_status -ne 0 ]; then
6398 failure_count=$((failure_count + 1))
6399 fi
6400 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006401
6402 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006403 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006404 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006405}
6406
6407# Preliminary setup
6408pre_check_environment
6409pre_initialize_variables
6410pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006411
Dave Rodgman21900632024-02-26 11:41:19 +00006412setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006413pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006414pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006415pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006416
Gilles Peskine878cf602019-01-06 20:50:38 +00006417build_status=0
6418if [ $KEEP_GOING -eq 1 ]; then
6419 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006420fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006421pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006422pre_print_configuration
6423pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006424cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006425if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006426 pre_generate_files
6427fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006428
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006429# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006430for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006431 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006432done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006433unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006434for component in $RUN_COMPONENTS; do
6435 run_component "component_$component"
6436done
Gilles Peskine8f073122018-11-27 15:58:47 +01006437
6438# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006439post_report