blob: b2f6bf2a4aca62e07d13b7c9c3b544fcbb44aff9 [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
Ronald Cron90279552024-07-04 09:25:59 +0200136 if [ -d tf-psa-crypto ]; then
137 CRYPTO_CONFIG_H='tf-psa-crypto/include/psa/crypto_config.h'
138 PSA_CORE_PATH='tf-psa-crypto/core'
139 BUILTIN_SRC_PATH='tf-psa-crypto/drivers/builtin/src'
140 else
141 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
142 fi
David Horstmann76a77382023-08-17 17:32:26 +0100143 else
144 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
Ronald Cron7e5d61c2024-06-10 14:25:46 +0200145 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Ronald Cron90279552024-07-04 09:25:59 +0200146 PSA_CORE_PATH='core'
147 BUILTIN_SRC_PATH='drivers/builtin/src'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100148 fi
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100149 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200150
151 # Files that are clobbered by some jobs will be backed up. Use a different
152 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
153 # independently decide when to remove the backup file.
154 backup_suffix='.all.bak'
155 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100156 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100157 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100158 # Files clobbered by in-tree cmake
159 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
160 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200161
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200162 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100163 MEMORY=0
164 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200165 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100166 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100167
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200168 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200169 #
170 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
171 # both values are kept in sync. If you change the value here because it
172 # breaks some tests, you'll definitely want to change it in
173 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200174 RELEASE_SEED=1
175
Yanray Wang18040ed2023-11-23 21:29:56 +0800176 # Specify character collation for regular expressions and sorting with C locale
177 export LC_COLLATE=C
178
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200179 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200180 : ${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 +0200181 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200182 export MBEDTLS_TEST_PLATFORM
183
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000184 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100185 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100186 : ${OPENSSL_NEXT:="$OPENSSL"}
187 : ${GNUTLS_CLI:="gnutls-cli"}
188 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
190 : ${ARMC5_BIN_DIR:=/usr/bin}
191 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200192 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200193 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100194 : ${CLANG_LATEST:="clang-latest"}
195 : ${CLANG_EARLIEST:="clang-earliest"}
196 : ${GCC_LATEST:="gcc-latest"}
197 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100198 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000199 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200200 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100201 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000202 # if CC is not set, use clang by default (if present) to improve build times
203 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000204 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000205 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000206
Ronald Cronc5e81d22024-04-02 14:39:53 +0200207 if [ -n "${OPENSSL_3+set}" ]; then
208 export OPENSSL_NEXT="$OPENSSL_3"
209 fi
210
Gilles Peskine396853a2021-09-20 18:57:55 +0200211 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000212 export CTEST_OUTPUT_ON_FAILURE=1
213
Gilles Peskine8fd59422019-10-21 17:11:33 +0200214 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100215 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200216 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000217 # Normally, tests should use this compiler for ASAN testing
218 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200219
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400220 # Platform tests have an allocation that returns null
221 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400222 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400223
Gilles Peskine878cf602019-01-06 20:50:38 +0000224 # Gather the list of available components. These are the functions
225 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100226 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000227
Valerio Setti9022f712024-06-27 07:59:39 +0200228 PSASIM_PATH='tests/psa-client-server/psasim/'
229
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000230 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100231 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100232}
Andres AG38495a32016-07-12 16:54:33 +0100233
Dave Rodgman21900632024-02-26 11:41:19 +0000234setup_quiet_wrappers()
235{
236 # Pick up "quiet" wrappers for make and cmake, which don't output very much
237 # unless there is an error. This reduces logging overhead in the CI.
238 #
239 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000240 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
241 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000242 fi
243}
244
Gilles Peskinea28db922019-01-10 00:05:18 +0100245# Test whether the component $1 is included in the command line patterns.
246is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100247{
Gilles Peskine03af6782021-08-06 11:35:17 +0200248 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
249 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100250 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000251 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100252 set +f
253 case ${1#component_} in $pattern) return 0;; esac
254 done
255 set +f
256 return 1
257}
Andres AG7770ea82016-10-10 15:46:20 +0100258
Simon Butcher41eeccf2016-09-07 00:07:09 +0100259usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100260{
Gilles Peskine709346a2017-12-10 23:43:39 +0100261 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100262Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100263Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100264By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100265COMPONENT can be the name of a component or a shell wildcard pattern.
266
267Examples:
268 $0 "check_*"
269 Run all sanity checks.
270 $0 --no-armcc --except test_memsan
271 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100272
273Special options:
274 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000275 --list-all-components List all available test components and exit.
276 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100277
278General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200279 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100280 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100281 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100282 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200283 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200284 --arm-none-eabi-gcc-prefix=<string>
285 Prefix for a cross-compiler for arm-none-eabi
286 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200287 --arm-linux-gnueabi-gcc-prefix=<string>
288 Prefix for a cross-compiler for arm-linux-gnueabi
289 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100290 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200291 --restore First clean up the build tree, restoring backed up
292 files. Do not run any components unless they are
293 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100294 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200295 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100296 --except Exclude the COMPONENTs listed on the command line,
297 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200298 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100299 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100300 --no-force Refuse to overwrite modified files (default).
301 --no-keep-going Stop at the first error (default).
302 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800303 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100304 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200305 --outcome-file=<path> File where test outcomes are written (not done if
306 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100307 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200308 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 -s|--seed Integer seed value to use for this test run.
310
311Tool path options:
312 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
313 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100314 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
315 --clang-latest=<Clang_latest_path> Latest version of clang available
316 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
317 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100318 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
319 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100320 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100321 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100322EOF
SimonB2e23c822016-04-16 21:54:39 +0100323}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100324
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200325# Cleanup before/after running a component.
326# Remove built files as well as the cmake cache/config.
327# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100328cleanup()
329{
David Horstmann76a77382023-08-17 17:32:26 +0100330 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100331 command make clean
332 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200333
Gilles Peskine31b07e22018-03-21 12:15:06 +0100334 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000335 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100336 -iname CMakeFiles -exec rm -rf {} \+ -o \
337 \( -iname cmake_install.cmake -o \
338 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200339 -iname CMakeCache.txt -o \
340 -path './cmake/*.cmake' \) -exec rm -f {} \+
Ronald Cron5cdc22b2024-06-12 10:04:22 +0200341 # Remove Makefiles generated by in-tree CMake builds
Ronald Cronf37ff7f2024-07-02 07:36:39 +0200342 rm -f pkgconfig/Makefile framework/Makefile
Ronald Cron5cdc22b2024-06-12 10:04:22 +0200343 rm -f include/Makefile programs/!(fuzz)/Makefile
Ronald Cron30ea2b92024-06-11 14:07:09 +0200344 rm -f tf-psa-crypto/Makefile tf-psa-crypto/include/Makefile
Ronald Cron82803982024-07-02 08:40:24 +0200345 rm -f tf-psa-crypto/core/Makefile tf-psa-crypto/drivers/Makefile
Ronald Cronf37ff7f2024-07-02 07:36:39 +0200346 rm -f tf-psa-crypto/drivers/everest/Makefile
347 rm -f tf-psa-crypto/drivers/p256-m/Makefile
Ronald Cron82803982024-07-02 08:40:24 +0200348 rm -f tf-psa-crypto/drivers/builtin/Makefile
349 rm -f tf-psa-crypto/drivers/builtin/src/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200350
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100351 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
352 rm -rf programs/test/cmake_subproject/build
353 rm -f programs/test/cmake_subproject/Makefile
354 rm -f programs/test/cmake_subproject/cmake_subproject
355
Chris Kayd259e342021-03-25 16:03:25 +0000356 # Remove any artifacts from the component_test_cmake_as_package test.
357 rm -rf programs/test/cmake_package/build
358 rm -f programs/test/cmake_package/Makefile
359 rm -f programs/test/cmake_package/cmake_package
360
361 # Remove any artifacts from the component_test_cmake_as_installed_package test.
362 rm -rf programs/test/cmake_package_install/build
363 rm -f programs/test/cmake_package_install/Makefile
364 rm -f programs/test/cmake_package_install/cmake_package_install
365
Gilles Peskinef83eb822020-03-30 20:11:39 +0200366 # Restore files that may have been clobbered by the job
367 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200368 if [[ -e "$x$backup_suffix" ]]; then
369 cp -p "$x$backup_suffix" "$x"
370 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200371 done
372}
John Durkopbd069d32020-10-31 22:14:03 -0700373
Valerio Setti9022f712024-06-27 07:59:39 +0200374# This is a helper function to be used in psasim builds. It is meant to clean
375# up the library's workspace after the server build and before the client
376# build. Built libraries (mbedcrypto, mbedx509 and mbedtls) are supposed to be
377# already copied to psasim folder at this point.
Valerio Settid8b59372024-07-02 12:02:25 +0200378helper_psasim_cleanup_before_client() {
Valerio Setti9022f712024-06-27 07:59:39 +0200379 # Clean up library files
380 make -C library clean
381 # Clean up intermediate files that were used to build the server
382 make -C $PSASIM_PATH clean_server_intermediate_files
383 # Restore files that were backup before building library files. This
384 # includes $CONFIG_H and $CRYPTO_CONFIG_H.
385 for x in $files_to_back_up; do
386 if [[ -e "$x$backup_suffix" ]]; then
387 cp -p "$x$backup_suffix" "$x"
388 fi
389 done
390}
391
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200392# Final cleanup when this script exits (except when exiting on a failure
393# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200394final_cleanup () {
395 cleanup
396
397 for x in $files_to_back_up; do
398 rm -f "$x$backup_suffix"
399 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100400}
401
Gilles Peskine7c652162017-12-11 00:01:40 +0100402# Executed on exit. May be redefined depending on command line options.
403final_report () {
404 :
405}
406
407fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200408 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100409 final_report $1
410 trap - $1
411 kill -$1 $$
412}
413
414trap 'fatal_signal HUP' HUP
415trap 'fatal_signal INT' INT
416trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200417
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200418# Number of processors on this machine. Used as the default setting
419# for parallel make.
420all_sh_nproc ()
421{
422 {
423 nproc || # Linux
424 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
425 sysctl -n hw.ncpu || # FreeBSD
426 echo 1
427 } 2>/dev/null
428}
429
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100430msg()
431{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100432 if [ -n "${current_component:-}" ]; then
433 current_section="${current_component#component_}: $1"
434 else
435 current_section="$1"
436 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200437
438 if [ $QUIET -eq 1 ]; then
439 return
440 fi
441
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100442 echo ""
443 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100444 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000445 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100446 echo "******************************************************************"
447}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100448
Gilles Peskine8f073122018-11-27 15:58:47 +0100449armc6_build_test()
450{
451 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100452
Gilles Peskine18487f62020-04-30 23:11:54 +0200453 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800454 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100455 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000456 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200457
458 msg "size: ARM Compiler 6 ($FLAGS)"
459 "$ARMC6_FROMELF" -z library/*.o
Ronald Cron90279552024-07-04 09:25:59 +0200460 if [ -n ${PSA_CORE_PATH} ]; then
461 "$ARMC6_FROMELF" -z ${PSA_CORE_PATH}/*.o
462 fi
463 if [ -n ${BUILTIN_SRC_PATH} ]; then
464 "$ARMC6_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
465 fi
Gilles Peskine8f073122018-11-27 15:58:47 +0100466}
Andres AGa5cd9732016-10-17 15:23:10 +0100467
Andres AGd9eba4b2016-08-26 14:42:14 +0100468err_msg()
469{
470 echo "$1" >&2
471}
472
473check_tools()
474{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200475 for tool in "$@"; do
476 if ! `type "$tool" >/dev/null 2>&1`; then
477 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100478 exit 1
479 fi
480 done
481}
482
Gilles Peskine8f073122018-11-27 15:58:47 +0100483pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000484 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100485 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100486 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100487 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200488 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000489 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100490
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000491 # Note that legacy options are ignored instead of being omitted from this
492 # list of options, so invocations that worked with previous version of
493 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100494 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100495 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200496 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200497 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200498 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000499 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100500 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
501 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100502 --clang-earliest) shift; CLANG_EARLIEST="$1";;
503 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100504 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000505 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100506 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100507 --gcc-earliest) shift; GCC_EARLIEST="$1";;
508 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100509 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200510 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
511 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100512 --gnutls-serv) shift; GNUTLS_SERV="$1";;
513 --help|-h) usage; exit;;
514 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000515 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100516 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100517 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200518 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000519 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100520 --no-force) FORCE=0;;
521 --no-keep-going) KEEP_GOING=0;;
522 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200523 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100524 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100525 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200526 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100527 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200528 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100529 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200530 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200531 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100532 --seed|-s) shift; SEED="$1";;
533 -*)
534 echo >&2 "Unknown option: $1"
535 echo >&2 "Run $0 --help for usage."
536 exit 120
537 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000538 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100539 esac
540 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100541 done
SimonB2e23c822016-04-16 21:54:39 +0100542
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100543 # Exclude components that are not supported on this platform.
544 SUPPORTED_COMPONENTS=
545 for component in $ALL_COMPONENTS; do
546 case $(type "support_$component" 2>&1) in
547 *' function'*)
548 if ! support_$component; then continue; fi;;
549 esac
550 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
551 done
552
553 if [ $list_components -eq 1 ]; then
554 printf '%s\n' $SUPPORTED_COMPONENTS
555 exit
556 fi
557
Gilles Peskinea28db922019-01-10 00:05:18 +0100558 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200559 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100561 fi
562
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000563 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
564 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100565 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000566 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100567 fi
SimonB2e23c822016-04-16 21:54:39 +0100568
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200569 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100570 if [ $all_except -eq 0 ]; then
571 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200572 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
573 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200574 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100575 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200576 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200577 # If the requested name includes a wildcard character, don't
578 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100579 case $component in
580 *[*?\[]*) continue;;
581 esac
582 case " $SUPPORTED_COMPONENTS " in
583 *" $component "*) :;;
584 *)
585 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
586 unsupported=$((unsupported + 1));;
587 esac
588 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200589 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100590 if [ $unsupported -ne 0 ]; then
591 exit 2
592 fi
593 fi
594
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000595 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100596 RUN_COMPONENTS=
597 for component in $SUPPORTED_COMPONENTS; do
598 if is_component_included "$component"; [ $? -eq $all_except ]; then
599 RUN_COMPONENTS="$RUN_COMPONENTS $component"
600 fi
601 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000602
603 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000604 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100605}
SimonB2e23c822016-04-16 21:54:39 +0100606
Gilles Peskine8f073122018-11-27 15:58:47 +0100607pre_check_git () {
608 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100609 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100610 git checkout-index -f -q $CONFIG_H
611 cleanup
612 else
SimonB2e23c822016-04-16 21:54:39 +0100613
Gilles Peskine8f073122018-11-27 15:58:47 +0100614 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
615 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
616 echo "You can either delete this directory manually, or force the test by rerunning"
617 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
618 exit 1
619 fi
620
Ronald Cron7a93ac52023-07-20 09:49:12 +0200621 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100622 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100623 echo "You can either delete or preserve your work, or force the test by rerunning the"
624 echo "script as: $0 --force"
625 exit 1
626 fi
SimonB2e23c822016-04-16 21:54:39 +0100627 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500628}
629
Gilles Peskine568f53a2021-07-12 18:16:01 +0200630pre_restore_files () {
631 # If the makefiles have been generated by a framework such as cmake,
632 # restore them from git. If the makefiles look like modifications from
633 # the ones checked into git, take care not to modify them. Whatever
634 # this function leaves behind is what the script will restore before
635 # each component.
636 case "$(head -n1 Makefile)" in
637 *[Gg]enerated*)
638 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
639 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
640 ;;
641 esac
642}
643
Gilles Peskinef83eb822020-03-30 20:11:39 +0200644pre_back_up () {
645 for x in $files_to_back_up; do
646 cp -p "$x" "$x$backup_suffix"
647 done
648}
649
Gilles Peskine8f073122018-11-27 15:58:47 +0100650pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100651 failure_count=0 # Number of failed components
652 last_failure_status=0 # Last failure status in this component
653
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100654 # See err_trap
655 previous_failure_status=0
656 previous_failed_command=
657 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100658 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100659
Gilles Peskine7c652162017-12-11 00:01:40 +0100660 start_red=
661 end_color=
662 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100663 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100664 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
665 start_red=$(printf '\033[31m')
666 end_color=$(printf '\033[0m')
667 ;;
668 esac
669 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100670
671 # Keep a summary of failures in a file. We'll print it out at the end.
672 failure_summary_file=$PWD/all-sh-failures-$$.log
673 : >"$failure_summary_file"
674
675 # Whether it makes sense to keep a component going after the specified
676 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200677 # This function normally receives the failing simple command
678 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
679 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100680 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200681 # False positives result in running things that can't be expected to
682 # work. False negatives result in things not running after something else
683 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100684 can_keep_going_after_failure () {
685 case "$1" in
686 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200687 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100688 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200689 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
690 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
691 *make*check*) true;;
692 "grep "*) true;;
693 "[ "*) true;;
694 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100695 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100696 esac
697 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100698
699 # This function runs if there is any error in a component.
700 # It must either exit with a nonzero status, or set
701 # last_failure_status to a nonzero value.
702 err_trap () {
703 # Save $? (status of the failing command). This must be the very
704 # first thing, before $? is overridden.
705 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100706 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100707
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100708 if [[ $last_failure_status -eq $previous_failure_status &&
709 "$failed_command" == "$previous_failed_command" &&
710 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
711 then
712 # The same command failed twice in a row, but this time one level
713 # less deep in the function call stack. This happens when the last
714 # command of a function returns a nonzero status, and the function
715 # returns that same status. Ignore the second failure.
716 previous_failure_funcall_depth=${#FUNCNAME[@]}
717 return
718 fi
719 previous_failure_status=$last_failure_status
720 previous_failed_command=$failed_command
721 previous_failure_funcall_depth=${#FUNCNAME[@]}
722
Gilles Peskinece266c42020-03-28 18:50:43 +0100723 text="$current_section: $failed_command -> $last_failure_status"
724 echo "${start_red}^^^^$text^^^^${end_color}" >&2
725 echo "$text" >>"$failure_summary_file"
726
727 # If the command is fatal (configure or build command), stop this
728 # component. Otherwise (test command) keep the component running
729 # (run more tests from the same build).
730 if ! can_keep_going_after_failure "$failed_command"; then
731 exit $last_failure_status
732 fi
733 }
734
Gilles Peskine7c652162017-12-11 00:01:40 +0100735 final_report () {
736 if [ $failure_count -gt 0 ]; then
737 echo
738 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100739 echo "${start_red}FAILED: $failure_count components${end_color}"
740 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100741 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
742 elif [ -z "${1-}" ]; then
743 echo "SUCCESS :)"
744 fi
745 if [ -n "${1-}" ]; then
746 echo "Killed by SIG$1."
747 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100748 rm -f "$failure_summary_file"
749 if [ $failure_count -gt 0 ]; then
750 exit 1
751 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100752 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100753}
754
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200755# record_status() and if_build_succeeded() are kept temporarily for backward
756# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100757record_status () {
758 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100759}
Gilles Peskine7c652162017-12-11 00:01:40 +0100760if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100761 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100762}
763
Gilles Peskinea681c592020-03-28 21:27:40 +0100764# '! true' does not trigger the ERR trap. Arrange to trigger it, with
765# a reasonably informative error message (not just "$@").
766not () {
767 if "$@"; then
768 report_failed_command="! $*"
769 false
770 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200771 fi
772}
773
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200774pre_prepare_outcome_file () {
775 case "$MBEDTLS_TEST_OUTCOME_FILE" in
776 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
777 esac
778 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
779 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
780 fi
781}
782
Gilles Peskine8f073122018-11-27 15:58:47 +0100783pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200784 if [ $QUIET -eq 1 ]; then
785 return
786 fi
787
Gilles Peskine8f073122018-11-27 15:58:47 +0100788 msg "info: $0 configuration"
789 echo "MEMORY: $MEMORY"
790 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200791 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100792 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100793 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100794 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100795 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
796 echo "GNUTLS_CLI: $GNUTLS_CLI"
797 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100798 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
799 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
800}
Andres AG7770ea82016-10-10 15:46:20 +0100801
Andres AGd9eba4b2016-08-26 14:42:14 +0100802# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100803pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000804 # Build the list of variables to pass to output_env.sh.
805 set env
SimonB2e23c822016-04-16 21:54:39 +0100806
Gilles Peskine87964262019-01-06 22:40:00 +0000807 case " $RUN_COMPONENTS " in
808 # Require OpenSSL and GnuTLS if running any tests (as opposed to
809 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
810 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100811 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000812 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
813 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100814 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000815 export GNUTLS_CLI="$GNUTLS_CLI"
816 export GNUTLS_SERV="$GNUTLS_SERV"
817 # Avoid passing --seed flag in every call to ssl-opt.sh
818 if [ -n "${SEED-}" ]; then
819 export SEED
820 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200821 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000822 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200823 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
824 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000825 ;;
826 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200827
Gilles Peskine87964262019-01-06 22:40:00 +0000828 case " $RUN_COMPONENTS " in
829 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
830 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100831
Gilles Peskine87964262019-01-06 22:40:00 +0000832 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200833 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000834 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100835
Gilles Peskine87964262019-01-06 22:40:00 +0000836 case " $RUN_COMPONENTS " in
837 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
838 esac
839
840 case " $RUN_COMPONENTS " in
841 *" test_zeroize "*) check_tools "gdb";;
842 esac
843
844 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000845 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000846 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
847 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200848 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000849 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
850 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200851 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
852 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
853 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000854 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000855
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200856 # past this point, no call to check_tool, only printing output
857 if [ $QUIET -eq 1 ]; then
858 return
859 fi
860
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000861 msg "info: output_env.sh"
862 case $RUN_COMPONENTS in
863 *_armcc*)
864 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
865 *) set "$@" RUN_ARMCC=0;;
866 esac
867 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100868}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100869
Gilles Peskine1570b592021-04-22 01:10:12 +0200870pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200871 # since make doesn't have proper dependencies, remove any possibly outdate
872 # file that might be around before generating fresh ones
873 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200874 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200875 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200876 else
877 make generated_files
878 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200879}
880
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000881clang_version() {
882 if command -v clang > /dev/null ; then
883 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
884 else
885 echo 0 # report version 0 for "no clang"
886 fi
887}
888
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200889################################################################
890#### Helpers for components using libtestdriver1
891################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100892
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200893# How to use libtestdriver1
894# -------------------------
895#
896# 1. Define the list algorithms and key types to accelerate,
897# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
898# Examples:
899# - loc_accel_list="ALG_JPAKE"
900# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200901# 2. Make configurations changes for the driver and/or main libraries.
902# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
903# can be either "default" to start with the default config, or a name
904# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200905# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200906# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
907# These changes affect both the driver and the main libraries.
908# (Note: they need to have the same set of PSA_WANT symbols, as that
909# determines the ABI between them.)
910# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
911# main libraries. Typically, you want to disable the module(s) that are
912# being accelerated. You may need to also disable modules that depend
913# on them or options that are not supported with drivers.
914# 2d. On top of psa/crypto_config.h, the driver library uses its own config
915# file: tests/include/test/drivers/config_test_driver.h. You usually
916# don't need to edit it: using loc_extra_list (see below) is preferred.
917# However, when there's no PSA symbol for what you want to enable,
918# calling scripts/config.py on this file remains the only option.
919# 3. Build the driver library, then the main libraries, test, and programs.
920# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
921# need to enable more algorithms here, typically hash algorithms when
922# accelerating some signature algorithms (ECDSA, RSAv2). This is done
923# by passing a 2nd argument listing the extra algorithms.
924# Example:
925# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
926# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800927# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200928# additional arguments will be passed to make: this can be useful if
929# you don't want to build everything when iterating during development.
930# Example:
931# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
932# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200933
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200934# Adjust the configuration - for both libtestdriver1 and main library,
935# as they should have the same PSA_WANT macros.
936helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200937 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200938 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200939 if [ "$base_config" != "default" ]; then
940 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200941 fi
942
943 # Enable PSA-based config (necessary to use drivers)
944 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
945
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200946 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
947 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
948 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000949
950 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
951 # otherwise we will end up running multithreaded tests without mutexes to protect them.
952 if scripts/config.py get MBEDTLS_THREADING_C; then
953 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
954 fi
955
956 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
957 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
958 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200959}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100960
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100961# Build the drivers library libtestdriver1.a (with ASan).
962#
963# Parameters:
964# 1. a space-separated list of things to accelerate;
965# 2. optional: a space-separate list of things to also support.
966# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
967helper_libtestdriver1_make_drivers() {
968 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
969 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
970}
971
972# Build the main libraries, programs and tests,
973# linking to the drivers library (with ASan).
974#
975# Parameters:
976# 1. a space-separated list of things to accelerate;
977# *. remaining arguments if any are passed directly to make
978# (examples: lib, -C tests test_suite_xxx, etc.)
979# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
980helper_libtestdriver1_make_main() {
981 loc_accel_list=$1
982 shift
983
984 # we need flags both with and without the LIBTESTDRIVER1_ prefix
985 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
986 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
987 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" "$@"
988}
989
Valerio Setti9022f712024-06-27 07:59:39 +0200990# Set some default values $CONFIG_H in order to build server or client sides
991# in PSASIM. There is only 1 mandatory parameter:
992# - $1: target which can be "client" or "server"
Valerio Settid8b59372024-07-02 12:02:25 +0200993helper_psasim_config() {
Valerio Settid1b6ef12024-05-07 16:00:21 +0200994 TARGET=$1
Valerio Settid1b6ef12024-05-07 16:00:21 +0200995
Valerio Settid1b6ef12024-05-07 16:00:21 +0200996 if [ "$TARGET" == "client" ]; then
997 scripts/config.py full
998 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
999 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1000 # Dynamic secure element support is a deprecated feature and it is not
1001 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1002 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1003 # Disable potentially problematic features
1004 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1005 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1006 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1007 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1008 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01001009 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +02001010 else
1011 scripts/config.py crypto_full
1012 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01001013 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
1014 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1015 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
1016 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +02001017 fi
Valerio Setti9022f712024-06-27 07:59:39 +02001018}
Valerio Settid1b6ef12024-05-07 16:00:21 +02001019
Valerio Setti9022f712024-06-27 07:59:39 +02001020# Helper to build the libraries for client/server in PSASIM. If the server is
1021# being built, then it builds also the final executable.
1022# There is only 1 mandatory parameter:
1023# - $1: target which can be "client" or "server"
1024helper_psasim_build() {
1025 TARGET=$1
1026 shift
1027 TARGET_LIB=${TARGET}_libs
1028
1029 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
1030
1031 # Build also the server application after its libraries have been built.
1032 if [ "$TARGET" == "server" ]; then
1033 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_server
1034 fi
Valerio Settid1b6ef12024-05-07 16:00:21 +02001035}
1036
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +01001037################################################################
1038#### Configuration helpers
1039################################################################
1040
Valerio Settib2fd6732023-08-15 17:10:47 +02001041# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +02001042# The function optionally accepts 1 parameter: a space-separated list of the
1043# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +02001044helper_disable_builtin_curves() {
1045 allowed_list="${1:-}"
1046 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
1047
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001048 for curve in $allowed_list; do
1049 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001050 done
1051}
1052
1053# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1054# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1055# in the following helpers.
1056helper_get_psa_curve_list () {
1057 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001058 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1059 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001060 done
1061
1062 echo "$loc_list"
1063}
1064
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001065# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1066# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1067# in the following helpers.
1068helper_get_psa_dh_group_list () {
1069 loc_list=""
1070 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1071 loc_list="$loc_list $item"
1072 done
1073
1074 echo "$loc_list"
1075}
1076
Valerio Settib2fd6732023-08-15 17:10:47 +02001077# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001078# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001079# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001080helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001081 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001082 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001083 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 +02001084 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1085 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001086 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1087 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001088 fi
1089 done
1090
1091 echo "$loc_list"
1092}
1093
Valerio Setti9022f712024-06-27 07:59:39 +02001094# Helper function for controlling (start & stop) the psasim server.
1095helper_psasim_server() {
1096 OPERATION=$1
1097 if [ "$OPERATION" == "start" ]; then
1098 (
1099 cd tests
1100 msg "start server"
1101 psa-client-server/psasim/test/start_server.sh
1102 )
1103 else
1104 (
1105 cd tests
1106 msg "terminate server and cleanup"
1107 psa-client-server/psasim//test/kill_server.sh
1108 )
1109 fi
1110}
1111
Gilles Peskine192c72f2017-12-21 15:59:21 +01001112################################################################
1113#### Basic checks
1114################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001115
1116#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001117# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001118#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001119# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001120# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001121# 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 +02001122# time, so start with a GCC build).
1123# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001124#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001125# Indicative running times are given for reference.
1126
Gilles Peskine8f073122018-11-27 15:58:47 +01001127component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001128 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001129 tests/scripts/recursion.pl library/*.c
Ronald Cron5b41a652024-07-03 08:59:47 +02001130 tests/scripts/recursion.pl ${PSA_CORE_PATH}/*.c
Ronald Cron709bbf02024-07-03 07:59:30 +02001131 tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001132}
Janos Follathb72c6782016-07-19 14:54:17 +01001133
Gilles Peskine67debb62021-05-18 16:09:50 +02001134component_check_generated_files () {
1135 msg "Check: check-generated-files, files generated with make" # 2s
1136 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001137 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001138
1139 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001140 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001141 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001142 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001143
1144 msg "Check: check-generated-files -u, files absent" # 2s
1145 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001146 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001147 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001148 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001149
1150 # This component ends with the generated files present in the source tree.
1151 # This is necessary for subsequent components!
1152}
1153
Gilles Peskine8f073122018-11-27 15:58:47 +01001154component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001155 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001156 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001157}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001158
Gilles Peskine8f073122018-11-27 15:58:47 +01001159component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001160 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001161 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001162}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001163
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001164component_check_changelog () {
1165 msg "Check: changelog entries" # < 1s
1166 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001167 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001168 if [ -e ChangeLog.new ]; then
1169 # Show the diff for information. It isn't an error if the diff is
1170 # non-empty.
1171 diff -u ChangeLog ChangeLog.new || true
1172 rm ChangeLog.new
1173 fi
1174}
1175
Gilles Peskine8f073122018-11-27 15:58:47 +01001176component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001177 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001178 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001179}
Darryl Greena07039c2018-03-13 16:48:16 +00001180
Gilles Peskine895868b2019-09-19 21:30:05 +02001181component_check_test_cases () {
1182 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001183 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001184 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001185 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001186 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001187 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001188 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001189 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001190}
1191
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001192component_check_test_dependencies () {
1193 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001194 # The purpose of this component is to catch unjustified dependencies on
1195 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1196 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1197 # MBEDTLS_PSA_xxx).
1198 #
1199 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1200 # this component is meant to catch. However a few of them are justified,
1201 # mostly by the absence of a PSA equivalent, so this component includes a
1202 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001203
1204 found="check-test-deps-found-$$"
1205 expected="check-test-deps-expected-$$"
1206
1207 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001208 grep 'depends_on' \
1209 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001210 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001211 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001212 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001213
Yanray Wang18040ed2023-11-23 21:29:56 +08001214 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001215 rm -f $expected
1216 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1217 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001218 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1219 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001220 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1221 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001222 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1223 # the test code and that's probably the most convenient way of achieving
1224 # the test's goal.
1225 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1226 # No PSA equivalent - we should probably have one in the future.
1227 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1228 # No PSA equivalent - needed by some init tests
1229 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001230 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001231 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001232
1233 # Compare reality with expectation.
1234 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001235 #
1236 # The output should be empty. When it's not:
1237 # - Each '+' line is a macro that was found but not expected. You want to
1238 # find where that macro occurs, and either replace it with PSA macros, or
1239 # add it to the exceptions list above with a justification.
1240 # - Each '-' line is a macro that was expected but not found; it means the
1241 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001242 diff -U0 $expected $found
1243
1244 rm $found $expected
1245}
1246
Gilles Peskine8f073122018-11-27 15:58:47 +01001247component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001248 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001249 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001250}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001251
Gilles Peskine192c72f2017-12-21 15:59:21 +01001252
Gilles Peskine636c26a2020-03-04 20:46:15 +01001253
Gilles Peskine192c72f2017-12-21 15:59:21 +01001254################################################################
1255#### Build and test many configurations and targets
1256################################################################
1257
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001258component_test_default_out_of_box () {
1259 msg "build: make, default config (out-of-box)" # ~1min
1260 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001261 # Disable fancy stuff
1262 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001263
1264 msg "test: main suites make, default config (out-of-box)" # ~10s
1265 make test
1266
1267 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001268 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001269
1270 msg "program demos: make, default config (out-of-box)" # ~10s
1271 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001272}
1273
Gilles Peskine8f073122018-11-27 15:58:47 +01001274component_test_default_cmake_gcc_asan () {
1275 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001276 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1277 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001278
Gilles Peskine8f073122018-11-27 15:58:47 +01001279 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1280 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001281
Gilles Peskine82b27272019-06-14 18:27:03 +02001282 msg "program demos (ASan build)" # ~10s
1283 tests/scripts/run_demos.py
1284
Gilles Peskine97bea012020-04-23 23:37:45 +02001285 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001286 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001287
Gilles Peskine6848d172023-11-02 19:58:03 +01001288 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001289 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001290
Gilles Peskine8f073122018-11-27 15:58:47 +01001291 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001292 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001293
Gilles Peskine8f073122018-11-27 15:58:47 +01001294 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001295 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001296
1297 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001298 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001299}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001300
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001301component_test_default_cmake_gcc_asan_new_bignum () {
1302 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001303 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001304 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001305 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001306
1307 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1308 make test
1309
1310 msg "test: selftest (ASan build)" # ~ 10s
1311 programs/test/selftest
1312
1313 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1314 tests/ssl-opt.sh
1315
1316 msg "test: compat.sh (ASan build)" # ~ 6 min
1317 tests/compat.sh
1318
1319 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1320 tests/context-info.sh
1321}
1322
Hanno Becker01635512019-02-26 14:27:09 +00001323component_test_full_cmake_gcc_asan () {
1324 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001325 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001326 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1327 make
1328
1329 msg "test: main suites (inc. selftests) (full config, ASan build)"
1330 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001331
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001332 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001333 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001334
Gilles Peskine636c26a2020-03-04 20:46:15 +01001335 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001336 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001337
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001338 # Note: the next two invocations cover all compat.sh test cases.
1339 # We should use the same here and in basic-build-test.sh.
1340 msg "test: compat.sh: default version (full config, ASan build)"
1341 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001342
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001343 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1344 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001345
1346 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001347 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001348}
1349
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001350
1351component_test_full_cmake_gcc_asan_new_bignum () {
1352 msg "build: full config, cmake, gcc, ASan"
1353 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001354 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001355 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001356 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001357
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001358 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001359 make test
1360
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001361 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001362 programs/test/selftest
1363
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001364 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001365 tests/ssl-opt.sh
1366
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001367 # Note: the next two invocations cover all compat.sh test cases.
1368 # We should use the same here and in basic-build-test.sh.
1369 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1370 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001371
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001372 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1373 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001374
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001375 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001376 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001377}
1378
Ronald Cronc3623db2020-10-29 10:51:32 +01001379component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001380 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001381 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001382 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1383 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1384 make
1385
1386 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1387 make test
1388}
1389
David Horstmann4a48bec2024-03-13 15:42:31 +00001390component_test_psa_assume_exclusive_buffers () {
1391 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001392 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001393 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001394 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1395 make
1396
David Horstmann4a48bec2024-03-13 15:42:31 +00001397 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001398 make test
1399}
1400
Gilles Peskinea3548672021-06-17 11:37:52 +02001401# check_renamed_symbols HEADER LIB
1402# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1403# name is LIB.
1404check_renamed_symbols () {
1405 ! nm "$2" | sed 's/.* //' |
1406 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1407}
1408
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001409component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001410 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001411 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001412 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1413 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1414 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1415 # We can only compile, not link, since our test and sample programs
1416 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1417 # is active.
1418 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001419
1420 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1421 # version is not present.
1422 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001423 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001424}
1425
Ryan Everettdaa322a2024-04-18 16:48:55 +01001426component_test_no_rsa_key_pair_generation() {
1427 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001428 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001429 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001430 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001431 make
1432
Ryan Everettdaa322a2024-04-18 16:48:55 +01001433 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001434 make test
1435}
1436
Gilles Peskine782f4112018-11-27 16:11:09 +01001437component_test_ref_configs () {
1438 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001439 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1440 # want to re-generate generated files that depend on it, quite correctly.
1441 # However this doesn't work as the generation script expects a specific
1442 # format for mbedtls_config.h, which the other files don't follow. Also,
1443 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001444 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001445 # whether they're on or off. So, disable cmake's (over-sensitive here)
1446 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001447 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001448 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001449 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001450}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001451
Gilles Peskine8f073122018-11-27 15:58:47 +01001452component_test_no_renegotiation () {
1453 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001454 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001455 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001456 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001457
Gilles Peskine8f073122018-11-27 15:58:47 +01001458 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1459 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001460
Gilles Peskine8f073122018-11-27 15:58:47 +01001461 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001462 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001463}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001464
Gilles Peskine636c26a2020-03-04 20:46:15 +01001465component_test_no_pem_no_fs () {
1466 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1467 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1468 scripts/config.py unset MBEDTLS_FS_IO
1469 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1470 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001471 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001472 make
1473
1474 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1475 make test
1476
1477 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001478 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001479}
1480
Gilles Peskine8f073122018-11-27 15:58:47 +01001481component_test_rsa_no_crt () {
1482 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001483 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001484 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001485 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001486
Gilles Peskine8f073122018-11-27 15:58:47 +01001487 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1488 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001489
Gilles Peskine8f073122018-11-27 15:58:47 +01001490 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001491 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001492
Gilles Peskine8f073122018-11-27 15:58:47 +01001493 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001494 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001495
1496 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001497 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001498}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001499
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001500component_test_no_ctr_drbg_classic () {
1501 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001502 scripts/config.py full
1503 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001504 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001505 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001506
Dave Rodgman17127e92023-12-14 16:42:48 +00001507 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001508 make
1509
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001510 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001511 make test
1512
Gilles Peskineba749042021-01-13 20:02:03 +01001513 # In this configuration, the TLS test programs use HMAC_DRBG.
1514 # The SSL tests are slow, so run a small subset, just enough to get
1515 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001516 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001517 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001518
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001519 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001520 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001521}
1522
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001523component_test_no_ctr_drbg_use_psa () {
1524 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001525 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001526 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1527 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001528
Dave Rodgman17127e92023-12-14 16:42:48 +00001529 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001530 make
1531
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001532 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1533 make test
1534
1535 # In this configuration, the TLS test programs use HMAC_DRBG.
1536 # The SSL tests are slow, so run a small subset, just enough to get
1537 # confidence that the SSL code copes with HMAC_DRBG.
1538 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001539 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540
1541 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001542 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001543}
1544
1545component_test_no_hmac_drbg_classic () {
1546 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1547 scripts/config.py full
1548 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1549 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1550 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001551 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001552
Dave Rodgman17127e92023-12-14 16:42:48 +00001553 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001554 make
1555
1556 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001557 make test
1558
Gilles Peskinea2224342020-11-19 22:14:34 +01001559 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1560 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1561 # instead.
1562 # Test SSL with non-deterministic ECDSA. Only test features that
1563 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001564 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001565 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001566
1567 # To save time, only test one protocol version, since this part of
1568 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001569 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001570 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001571}
1572
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001573component_test_no_hmac_drbg_use_psa () {
1574 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1575 scripts/config.py full
1576 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1577 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1578 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1579
Dave Rodgman17127e92023-12-14 16:42:48 +00001580 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001581 make
1582
1583 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1584 make test
1585
1586 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1587 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1588 # instead.
1589 # Test SSL with non-deterministic ECDSA. Only test features that
1590 # might be affected by how ECDSA signature is performed.
1591 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001592 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001593
1594 # To save time, only test one protocol version, since this part of
1595 # the protocol is identical in (D)TLS up to 1.2.
1596 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001597 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001598}
1599
1600component_test_psa_external_rng_no_drbg_classic () {
1601 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1602 scripts/config.py full
1603 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001604 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001605 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001606 scripts/config.py unset MBEDTLS_ENTROPY_C
1607 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1608 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001609 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1610 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1611 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001612 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1613 # the SSL test programs don't have an RNG and can't work. Explicitly
1614 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001615 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001616
1617 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1618 make test
1619
Gilles Peskine8eb29432021-02-03 20:07:11 +01001620 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001621 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001622}
1623
1624component_test_psa_external_rng_no_drbg_use_psa () {
1625 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001626 scripts/config.py full
1627 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001628 scripts/config.py unset MBEDTLS_ENTROPY_C
1629 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1630 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001631 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1632 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1633 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001634 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001635
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001636 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001637 make test
1638
Gilles Peskine8eb29432021-02-03 20:07:11 +01001639 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001640 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001641}
1642
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001643component_test_psa_external_rng_use_psa_crypto () {
1644 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1645 scripts/config.py full
1646 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1647 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1648 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001649 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001650
1651 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1652 make test
1653
1654 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1655 tests/ssl-opt.sh -f 'Default\|opaque'
1656}
1657
Gilles Peskine801c4332023-04-28 21:04:28 +02001658component_test_psa_inject_entropy () {
1659 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1660 scripts/config.py full
1661 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1662 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1663 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1664 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1665 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1666 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001667 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 +02001668
1669 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1670 make test
1671}
1672
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001673component_test_sw_inet_pton () {
1674 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1675
1676 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1677 scripts/config.py set MBEDTLS_TEST_HOOKS
1678 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1679
1680 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1681 make test
1682}
1683
Valerio Settia41654d2024-02-08 10:33:11 +01001684component_full_no_pkparse_pkwrite() {
1685 msg "build: full without pkparse and pkwrite"
1686
1687 scripts/config.py crypto_full
1688 scripts/config.py unset MBEDTLS_PK_PARSE_C
1689 scripts/config.py unset MBEDTLS_PK_WRITE_C
1690
Valerio Settia41654d2024-02-08 10:33:11 +01001691 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1692
1693 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
Ronald Cron709bbf02024-07-03 07:59:30 +02001694 not grep mbedtls_pk_parse_key ${BUILTIN_SRC_PATH}/pkparse.o
1695 not grep mbedtls_pk_write_key_der ${BUILTIN_SRC_PATH}/pkwrite.o
Valerio Settia41654d2024-02-08 10:33:11 +01001696
1697 msg "test: full without pkparse and pkwrite"
1698 make test
1699}
1700
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001701component_test_crypto_full_md_light_only () {
1702 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001703 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001704
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001705 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001706 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001707 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001708 scripts/config.py unset MBEDTLS_HKDF_C
1709 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001710 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001711 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001712 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001713 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001714 # Disable things that would auto-enable MD_C
1715 scripts/config.py unset MBEDTLS_PKCS5_C
1716
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001717 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1718 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001719 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001720
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001721 # Make sure we don't have the HMAC functions, but the hashing functions
Ronald Cron709bbf02024-07-03 07:59:30 +02001722 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1723 grep mbedtls_md ${BUILTIN_SRC_PATH}/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001724
1725 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001726 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001727}
1728
Ronald Cron8dbea482024-05-23 16:04:11 +02001729component_test_full_no_cipher () {
1730 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001731
1732 scripts/config.py full
1733 scripts/config.py unset MBEDTLS_CIPHER_C
1734
Ronald Cron8dbea482024-05-23 16:04:11 +02001735 # The built-in implementation of the following algs/key-types depends
1736 # on CIPHER_C so we disable them.
1737 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1738 # so we keep them enabled.
1739 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1740 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1741 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1742 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1743 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1744 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1745 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1746 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1747 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1748 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1749 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1750
Valerio Settic84d9402023-10-23 14:58:25 +02001751 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001752 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001753 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001754
Gilles Peskine21570cf2023-12-22 11:49:50 +01001755 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001756
Valerio Setti7e710e82023-08-25 09:14:15 +02001757 # Ensure that CIPHER_C was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02001758 not grep mbedtls_cipher_init ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti7e710e82023-08-25 09:14:15 +02001759
Ronald Cron8dbea482024-05-23 16:04:11 +02001760 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001761 make test
1762}
1763
Valerio Settibdfecb62023-11-07 15:37:20 +01001764component_test_full_no_ccm() {
1765 msg "build: full no PSA_WANT_ALG_CCM"
1766
1767 # Full config enables:
1768 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1769 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1770 scripts/config.py full
1771
1772 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1773 # enabled, but not used from TLS since USE_PSA is set.
1774 # This is helpful to ensure that TLS tests below have proper dependencies.
1775 #
1776 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1777 # PSA_WANT_ALG_CCM to be re-enabled.
1778 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1779
Gilles Peskine21570cf2023-12-22 11:49:50 +01001780 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001781
1782 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001783 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001784}
1785
1786component_test_full_no_ccm_star_no_tag() {
1787 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1788
1789 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1790 scripts/config.py full
1791
1792 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1793 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1794 # This basically disables all unauthenticated ciphers on the PSA side, while
1795 # keeping AEADs enabled.
1796 #
1797 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1798 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1799 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1800 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1801 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1802 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1803 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1804 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1805 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1806 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1807
Gilles Peskine21570cf2023-12-22 11:49:50 +01001808 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001809
1810 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Ronald Cron5b41a652024-07-03 08:59:47 +02001811 not grep mbedtls_psa_cipher ${PSA_CORE_PATH}/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001812
1813 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001814 make test
1815}
1816
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001817component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001818 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001819
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001820 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001821 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001822 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001823 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001824 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001825 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1826 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001827 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001828 scripts/config.py unset MBEDTLS_GCM_C
1829 scripts/config.py unset MBEDTLS_CCM_C
1830 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001831 #Disable TLS 1.3 (as no AEAD)
1832 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001833 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1834 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1835 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001836 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney67338c02024-05-09 15:21:14 +01001837 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001838 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001839 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001840 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001841 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1842 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001843 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001844 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001845 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001846
Przemek Stekiel9550c052022-09-28 09:51:55 +02001847 make
1848
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001849 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001850 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001851
1852 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001853}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001854
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001855component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001856 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001857
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001858 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001859 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001860 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001861 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001862 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001863 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1864 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001865 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001866 scripts/config.py unset MBEDTLS_GCM_C
1867 scripts/config.py unset MBEDTLS_CCM_C
1868 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001869 #Disable TLS 1.3 (as no AEAD)
1870 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001871 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubney62586212024-04-26 17:01:16 +01001872 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001873 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001874 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001875 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001876 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001877 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001878 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001879 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001880
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001881 make
1882
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001883 msg "test: default with only CBC-legacy cipher use psa"
1884 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001885
1886 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1887 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001888}
1889
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001890component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001891 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001892
1893 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001894 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001895 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001896 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001897 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001898 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1899 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001900 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001901 scripts/config.py unset MBEDTLS_GCM_C
1902 scripts/config.py unset MBEDTLS_CCM_C
1903 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001904 #Disable TLS 1.3 (as no AEAD)
1905 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001906 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001907 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001908 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1909 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1910 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001911 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001912 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001913 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001914 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001915
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001916 make
1917
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001918 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001919 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001920
1921 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1922 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001923}
1924
Valerio Setti9f0ec532022-11-08 13:03:24 +01001925# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1926# that we could use for interop testing. However, we now have sort of two
1927# implementations ourselves: one using PSA, the other not. At least test that
1928# these two interoperate with each other.
1929component_test_tls1_2_ecjpake_compatibility() {
1930 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1931 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001932 # Explicitly make lib first to avoid a race condition:
1933 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1934 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001935 make -C programs ssl/ssl_server2 ssl/ssl_client2
1936 cp programs/ssl/ssl_server2 s2_no_use_psa
1937 cp programs/ssl/ssl_client2 c2_no_use_psa
1938
1939 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1940 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1941 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001942 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001943 make -C programs ssl/ssl_server2 ssl/ssl_client2
1944 make -C programs test/udp_proxy test/query_compile_time_config
1945
Valerio Setti70e02902022-12-02 16:21:56 +01001946 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1947 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1948 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1949 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1950 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1951 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1952 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1953 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 +01001954
1955 rm s2_no_use_psa c2_no_use_psa
1956}
1957
Gilles Peskine636c26a2020-03-04 20:46:15 +01001958component_test_everest () {
1959 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001960 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1961 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1962 make
1963
1964 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1965 make test
1966
Gilles Peskine6848d172023-11-02 19:58:03 +01001967 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001968 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001969
Gilles Peskine636c26a2020-03-04 20:46:15 +01001970 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001971 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001972
1973 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1974 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001975 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001976}
1977
Gilles Peskined3beca92020-07-03 00:15:37 +02001978component_test_everest_curve25519_only () {
1979 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001980 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02001981 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1982 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001983 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1984 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
1985 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02001986 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1987 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001988 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001989 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
1990
Gilles Peskined3beca92020-07-03 00:15:37 +02001991 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001992 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001993 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
1994 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02001995
Dave Rodgman17127e92023-12-14 16:42:48 +00001996 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02001997
1998 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1999 make test
2000}
2001
Gilles Peskine8f073122018-11-27 15:58:47 +01002002component_test_small_ssl_out_content_len () {
2003 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002004 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2005 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002006 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002007 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002008
Gilles Peskine8f073122018-11-27 15:58:47 +01002009 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002010 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002011}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002012
Gilles Peskine8f073122018-11-27 15:58:47 +01002013component_test_small_ssl_in_content_len () {
2014 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002015 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2016 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002017 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002018 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002019
Gilles Peskine8f073122018-11-27 15:58:47 +01002020 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002021 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002022}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002023
Gilles Peskine8f073122018-11-27 15:58:47 +01002024component_test_small_ssl_dtls_max_buffering () {
2025 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002026 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
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 MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002031 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 +01002032}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002033
Gilles Peskine8f073122018-11-27 15:58:47 +01002034component_test_small_mbedtls_ssl_dtls_max_buffering () {
2035 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002036 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
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
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002039
Gilles Peskine8f073122018-11-27 15:58:47 +01002040 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002041 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002042}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002043
Gilles Peskine75cc7712019-09-06 19:47:17 +02002044component_test_psa_collect_statuses () {
2045 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002046 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002047 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002048 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002049 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002050 rm -f tests/statuses.log
2051}
2052
Gilles Peskine8f073122018-11-27 15:58:47 +01002053component_test_full_cmake_clang () {
2054 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002055 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002056 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 +01002057 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002058
k-stachowiak0291cb72019-06-26 15:52:12 +02002059 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002060 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002061
Gilles Peskineda6017c2022-10-30 21:02:40 +01002062 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2063 programs/test/cpp_dummy_build
2064
Gilles Peskine6848d172023-11-02 19:58:03 +01002065 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002066 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002067
Gilles Peskine82b27272019-06-14 18:27:03 +02002068 msg "program demos (full config, clang)" # ~10s
2069 tests/scripts/run_demos.py
2070
k-stachowiak0291cb72019-06-26 15:52:12 +02002071 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002072 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002073
Gilles Peskine8f073122018-11-27 15:58:47 +01002074 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002075 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002076}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002077
Gilles Peskine0c671602022-11-29 16:01:41 +01002078skip_suites_without_constant_flow () {
2079 # Skip the test suites that don't have any constant-flow annotations.
2080 # This will need to be adjusted if we ever start declaring things as
2081 # secret from macros or functions inside tests/include or tests/src.
2082 SKIP_TEST_SUITES=$(
2083 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2084 sed 's/test_suite_//; s/\.function$//' |
2085 tr '\n' ,)
2086 export SKIP_TEST_SUITES
2087}
2088
Dave Rodgman246210e2023-07-31 18:07:44 +01002089skip_all_except_given_suite () {
2090 # Skip all but the given test suite
2091 SKIP_TEST_SUITES=$(
2092 ls -1 tests/suites/test_suite_*.function |
2093 grep -v $1.function |
2094 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2095 tr '\n' ,)
2096 export SKIP_TEST_SUITES
2097}
2098
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002099component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002100 # This tests both (1) accesses to undefined memory, and (2) branches or
2101 # memory access depending on secret values. To distinguish between those:
2102 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2103 # - or alternatively, change the build type to MemSanDbg, which enables
2104 # origin tracking and nicer stack traces (which are useful for debugging
2105 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002106 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2107 scripts/config.py full
2108 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2109 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2110 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2111 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2112 make
2113
2114 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2115 make test
2116}
2117
2118component_test_memsan_constant_flow_psa () {
2119 # This tests both (1) accesses to undefined memory, and (2) branches or
2120 # memory access depending on secret values. To distinguish between those:
2121 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2122 # - or alternatively, change the build type to MemSanDbg, which enables
2123 # origin tracking and nicer stack traces (which are useful for debugging
2124 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002125 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002126 scripts/config.py full
2127 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2128 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2129 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2130 make
2131
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002132 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002133 make test
2134}
2135
Bence Szépkúti0354d042023-12-06 16:14:37 +01002136component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002137 # This tests both (1) everything that valgrind's memcheck usually checks
2138 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2139 # etc.) and (2) branches or memory access depending on secret values,
2140 # which will be reported as uninitialized memory. To distinguish between
2141 # secret and actually uninitialized:
2142 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2143 # - or alternatively, build with debug info and manually run the offending
2144 # test suite with valgrind --track-origins=yes, then check if the origin
2145 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002146 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2147 scripts/config.py full
2148 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2149 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002150 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002151 cmake -D CMAKE_BUILD_TYPE:String=Release .
2152 make
2153
2154 # this only shows a summary of the results (how many of each type)
2155 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002156 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002157 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002158
2159 # Test asm path in constant time module - by default, it will test the plain C
2160 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2161 msg "test: valgrind asm constant_time"
2162 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2163 skip_all_except_given_suite test_suite_constant_time
2164 cmake -D CMAKE_BUILD_TYPE:String=Release .
2165 make clean
2166 make
2167 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002168}
2169
Bence Szépkúti0354d042023-12-06 16:14:37 +01002170component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002171 # This tests both (1) everything that valgrind's memcheck usually checks
2172 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2173 # etc.) and (2) branches or memory access depending on secret values,
2174 # which will be reported as uninitialized memory. To distinguish between
2175 # secret and actually uninitialized:
2176 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2177 # - or alternatively, build with debug info and manually run the offending
2178 # test suite with valgrind --track-origins=yes, then check if the origin
2179 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002180 msg "build: cmake release GCC, full config with constant flow testing"
2181 scripts/config.py full
2182 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002183 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002184 cmake -D CMAKE_BUILD_TYPE:String=Release .
2185 make
2186
2187 # this only shows a summary of the results (how many of each type)
2188 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002189 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002190 make memcheck
2191}
2192
Janos Follath9338cac2023-10-04 18:55:39 +01002193component_test_tsan () {
2194 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002195 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002196 scripts/config.py set MBEDTLS_THREADING_C
2197 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002198 # Self-tests do not currently use multiple threads.
2199 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002200
Ryan6caf84f2024-03-05 13:57:00 +00002201 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2202 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2203
Janos Follath9338cac2023-10-04 18:55:39 +01002204 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2205 make
2206
2207 msg "test: main suites (TSan)"
2208 make test
2209}
2210
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002211component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002212 # Test that removing the deprecated features from the default
2213 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002214 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2215 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002216 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002217
2218 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2219 make test
2220}
2221
2222component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002223 msg "build: make, full_no_deprecated config" # ~ 30s
2224 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002225 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002226
Gilles Peskine30de2e82020-04-20 21:39:22 +02002227 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002228 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002229
2230 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2231 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002232}
2233
Gilles Peskine8386ea22020-04-30 09:07:29 +02002234component_test_full_no_deprecated_deprecated_warning () {
2235 # Test that there is nothing deprecated in "full_no_deprecated".
2236 # A deprecated feature would trigger a warning (made fatal) from
2237 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002238 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2239 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002240 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2241 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002242 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002243
Gilles Peskine30de2e82020-04-20 21:39:22 +02002244 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002245 make test
2246}
2247
Gilles Peskine8386ea22020-04-30 09:07:29 +02002248component_test_full_deprecated_warning () {
2249 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2250 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002251 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002252 scripts/config.py full
2253 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002254 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002255 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2256 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002257 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002258
Gilles Peskine8386ea22020-04-30 09:07:29 +02002259 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2260 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2261 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002262 # Expect warnings from '#warning' directives in check_config.h and
2263 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002264 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 +01002265
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002266 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2267 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002268
2269 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2270 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002271}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002272
Gilles Peskineec541fe2020-01-31 14:24:14 +01002273# Check that the specified libraries exist and are empty.
2274are_empty_libraries () {
2275 nm "$@" >/dev/null 2>/dev/null
2276 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2277}
2278
2279component_build_crypto_default () {
2280 msg "build: make, crypto only"
2281 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002282 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002283 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002284}
2285
2286component_build_crypto_full () {
2287 msg "build: make, crypto only, full config"
2288 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002289 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002290 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002291}
2292
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002293component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002294 msg "build: make, config for PSA crypto service"
2295 scripts/config.py crypto
2296 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2297 # Disable things that are not needed for just cryptography, to
2298 # reach a configuration that would be typical for a PSA cryptography
2299 # service providing all implemented PSA algorithms.
2300 # System stuff
2301 scripts/config.py unset MBEDTLS_ERROR_C
2302 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002303 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002304 # Crypto stuff with no PSA interface
2305 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002306 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002307 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002308 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002309 scripts/config.py unset MBEDTLS_NIST_KW_C
2310 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2311 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2312 scripts/config.py unset MBEDTLS_PKCS12_C
2313 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002314 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2315 # in PSA code to work with RSA keys. We don't require users to set those:
2316 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002317 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002318 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002319 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002320 make CFLAGS='-O1 -Werror' all test
2321 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2322}
2323
Gilles Peskineec541fe2020-01-31 14:24:14 +01002324component_build_crypto_baremetal () {
2325 msg "build: make, crypto only, baremetal config"
2326 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002327 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002328 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002329}
Daniel Axtens446af202020-09-02 21:30:13 +10002330support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002331 support_build_baremetal "$@"
2332}
2333
2334component_build_baremetal () {
2335 msg "build: make, baremetal config"
2336 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002337 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002338}
2339support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002340 # Older Glibc versions include time.h from other headers such as stdlib.h,
2341 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2342 # problem, Ubuntu 18.04 is ok.
2343 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2344}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002345
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002346# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002347component_test_depends_py_cipher_id () {
2348 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002349 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002350}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002351
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002352component_test_depends_py_cipher_chaining () {
2353 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002354 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002355}
2356
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002357component_test_depends_py_cipher_padding () {
2358 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002359 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002360}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002361
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002362component_test_depends_py_curves () {
2363 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002364 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002365}
2366
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002367component_test_depends_py_hashes () {
2368 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002369 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002370}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002371
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002372component_test_depends_py_kex () {
2373 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002374 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002375}
2376
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002377component_test_depends_py_pkalgs () {
2378 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002379 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002380}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002381
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002382# PSA equivalents of the depends.py tests
2383component_test_depends_py_cipher_id_psa () {
2384 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002385 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002386}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002387
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002388component_test_depends_py_cipher_chaining_psa () {
2389 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002390 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002391}
2392
2393component_test_depends_py_cipher_padding_psa () {
2394 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002395 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002396}
2397
2398component_test_depends_py_curves_psa () {
2399 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002400 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002401}
2402
2403component_test_depends_py_hashes_psa () {
2404 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002405 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002406}
2407
2408component_test_depends_py_kex_psa () {
2409 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002410 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002411}
2412
2413component_test_depends_py_pkalgs_psa () {
2414 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002415 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002416}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002417
Valerio Setti6bed64e2024-01-17 15:21:44 +01002418component_test_psa_crypto_config_ffdh_2048_only () {
2419 msg "build: full config - only DH 2048"
2420
2421 scripts/config.py full
2422
2423 # Disable all DH groups other than 2048.
2424 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2425 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2426 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2427 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2428
2429 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2430
2431 msg "test: full config - only DH 2048"
2432 make test
2433
2434 msg "ssl-opt: full config - only DH 2048"
2435 tests/ssl-opt.sh -f "ffdh"
2436}
2437
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002438component_build_no_pk_rsa_alt_support () {
2439 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2440
2441 scripts/config.py full
2442 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2443 scripts/config.py set MBEDTLS_RSA_C
2444 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2445
2446 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002447 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002448}
2449
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002450component_build_module_alt () {
2451 msg "build: MBEDTLS_XXX_ALT" # ~30s
2452 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002453
2454 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002455 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002456 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002457 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002458 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2459 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002460 # You can only have one threading implementation: alt or pthread, not both.
2461 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002462 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2463 # directly and assumes the implementation works with partial groups.
2464 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002465 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2466 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2467 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002468 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2469 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2470 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002471
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002472 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2473 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2474 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002475
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002476 # We can only compile, not link, since we don't have any implementations
2477 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002478 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002479}
2480
Gilles Peskine64996c32024-01-23 20:25:47 +01002481component_test_no_psa_crypto_full_cmake_asan() {
2482 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2483 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002484 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002485 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002486 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002487 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002488 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002489 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002490 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002491 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002492 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002493 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002494 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002495 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002496
Gilles Peskine64996c32024-01-23 20:25:47 +01002497 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002498 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002499
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002500 # Note: ssl-opt.sh has some test cases that depend on
2501 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2502 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002503 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002504 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002505
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002506 # Note: the next two invocations cover all compat.sh test cases.
2507 # We should use the same here and in basic-build-test.sh.
2508 msg "test: compat.sh: default version (full minus PSA crypto)"
2509 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002510
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002511 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002512 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002513}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002514
Ronald Cron403c15c2021-09-13 09:38:05 +02002515component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002516 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002517
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002518 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002519 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002520 $(helper_get_psa_key_type_list "ECC") \
2521 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002522
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002523 # Configure
2524 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002525
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002526 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002527 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002528
2529 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002530 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002531
2532 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002533 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2534 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2535
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002536 # Build
2537 # -----
2538
2539 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002540 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2541 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002542
2543 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2544
Valerio Setti3fe105b2023-10-30 11:08:12 +01002545 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002546
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002547 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002548 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002549
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002550 # Run the tests
2551 # -------------
2552
Ronald Cron403c15c2021-09-13 09:38:05 +02002553 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2554 make test
2555}
2556
Valerio Setti44b178c2023-03-22 14:02:57 +01002557component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002558 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002559
2560 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002561 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002562 $(helper_get_psa_key_type_list "ECC") \
2563 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002564
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002565 # Configure
2566 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002567
Ronald Cron46ac0652024-03-18 12:39:04 +01002568 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002569 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002570
Valerio Setti44b178c2023-03-22 14:02:57 +01002571 # Disable the module that's accelerated
2572 scripts/config.py unset MBEDTLS_ECDH_C
2573
2574 # Disable things that depend on it
2575 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2576 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2577 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2578 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2579 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2580
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002581 # Build
2582 # -----
2583
2584 helper_libtestdriver1_make_drivers "$loc_accel_list"
2585
Valerio Setti3fe105b2023-10-30 11:08:12 +01002586 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002587
Valerio Setti44b178c2023-03-22 14:02:57 +01002588 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002589 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002590
2591 # Run the tests
2592 # -------------
2593
Valerio Setti44b178c2023-03-22 14:02:57 +01002594 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002595 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002596}
2597
Przemek Stekieldccb2022023-05-11 10:48:50 +02002598component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002599 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002600
2601 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002602 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002603 $(helper_get_psa_key_type_list "DH") \
2604 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002605
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002606 # Configure
2607 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002608
Przemek Stekiel565353e2023-07-05 11:07:07 +02002609 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002610 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002611
2612 # Disable the module that's accelerated
2613 scripts/config.py unset MBEDTLS_DHM_C
2614
2615 # Disable things that depend on it
2616 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2617 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2618
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002619 # Build
2620 # -----
2621
2622 helper_libtestdriver1_make_drivers "$loc_accel_list"
2623
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002624 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002625
2626 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002627 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Przemek Stekieldccb2022023-05-11 10:48:50 +02002628
2629 # Run the tests
2630 # -------------
2631
Gilles Peskine14302ed2023-07-19 19:30:04 +02002632 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002633 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002634
Gilles Peskine14302ed2023-07-19 19:30:04 +02002635 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002636 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002637}
2638
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002639component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002640 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002641
2642 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002643 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002644
2645 # Disable things that are not supported
2646 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2647 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002648 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002649
Gilles Peskine14302ed2023-07-19 19:30:04 +02002650 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002651 make test
2652
Gilles Peskine14302ed2023-07-19 19:30:04 +02002653 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002654 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002655}
2656
Valerio Setti44b178c2023-03-22 14:02:57 +01002657component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002658 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002659
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002660 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002661 $(helper_get_psa_key_type_list "ECC") \
2662 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002663
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002664 # Configure
2665 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002666
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002667 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002668
2669 # Make built-in fallback not available
2670 scripts/config.py unset MBEDTLS_ECJPAKE_C
2671 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2672
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002673 # Build
2674 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002675
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002676 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002677
Valerio Setti3fe105b2023-10-30 11:08:12 +01002678 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002679
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002680 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002681 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002682
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002683 # Run the tests
2684 # -------------
2685
Gilles Peskine14302ed2023-07-19 19:30:04 +02002686 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002687 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002688}
2689
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002690component_test_psa_crypto_config_accel_ecc_some_key_types () {
2691 msg "build: full with accelerated EC algs and some key types"
2692
2693 # Algorithms and key types to accelerate
2694 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2695 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2696 ALG_ECDH \
2697 ALG_JPAKE \
2698 KEY_TYPE_ECC_PUBLIC_KEY \
2699 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2700 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002701 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2702 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002703
2704 # Configure
2705 # ---------
2706
2707 # start with config full for maximum coverage (also enables USE_PSA)
2708 helper_libtestdriver1_adjust_config "full"
2709
2710 # Disable modules that are accelerated - some will be re-enabled
2711 scripts/config.py unset MBEDTLS_ECDSA_C
2712 scripts/config.py unset MBEDTLS_ECDH_C
2713 scripts/config.py unset MBEDTLS_ECJPAKE_C
2714 scripts/config.py unset MBEDTLS_ECP_C
2715
2716 # Disable all curves - those that aren't accelerated should be re-enabled
2717 helper_disable_builtin_curves
2718
2719 # Restartable feature is not yet supported by PSA. Once it will in
2720 # the future, the following line could be removed (see issues
2721 # 6061, 6332 and following ones)
2722 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2723
2724 # this is not supported by the driver API yet
2725 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2726
2727 # Build
2728 # -----
2729
2730 # These hashes are needed for some ECDSA signature tests.
2731 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2732 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2733 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2734
Valerio Setti3fe105b2023-10-30 11:08:12 +01002735 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002736
2737 # ECP should be re-enabled but not the others
Ronald Cron709bbf02024-07-03 07:59:30 +02002738 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2739 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2740 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
2741 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002742
2743 # Run the tests
2744 # -------------
2745
2746 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002747 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002748}
2749
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002750# Run tests with only (non-)Weierstrass accelerated
2751# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002752# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2753# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002754common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002755 weierstrass=$1
2756 if [ $weierstrass -eq 1 ]; then
2757 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002758 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002759 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002760 fi
2761
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002762 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002763
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002764 # Note: Curves are handled in a special way by the libtestdriver machinery,
2765 # so we only want to include them in the accel list when building the main
2766 # libraries, hence the use of a separate variable.
2767 # Note: the following loop is a modified version of
2768 # helper_get_psa_curve_list that only keeps Weierstrass families.
2769 loc_weierstrass_list=""
2770 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002771 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2772 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002773 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002774 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002775 ;;
2776 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002777 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002778 ;;
2779 esac
2780 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002781 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002782 loc_curve_list=$loc_weierstrass_list
2783 else
2784 loc_curve_list=$loc_non_weierstrass_list
2785 fi
2786
Valerio Setti3fe105b2023-10-30 11:08:12 +01002787 # Algorithms and key types to accelerate
2788 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2789 ALG_ECDH \
2790 ALG_JPAKE \
2791 $(helper_get_psa_key_type_list "ECC") \
2792 $loc_curve_list"
2793
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002794 # Configure
2795 # ---------
2796
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002797 # Start with config crypto_full and remove PK_C:
2798 # that's what's supported now, see docs/driver-only-builds.md.
2799 helper_libtestdriver1_adjust_config "crypto_full"
2800 scripts/config.py unset MBEDTLS_PK_C
2801 scripts/config.py unset MBEDTLS_PK_PARSE_C
2802 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002803
2804 # Disable modules that are accelerated - some will be re-enabled
2805 scripts/config.py unset MBEDTLS_ECDSA_C
2806 scripts/config.py unset MBEDTLS_ECDH_C
2807 scripts/config.py unset MBEDTLS_ECJPAKE_C
2808 scripts/config.py unset MBEDTLS_ECP_C
2809
2810 # Disable all curves - those that aren't accelerated should be re-enabled
2811 helper_disable_builtin_curves
2812
2813 # Restartable feature is not yet supported by PSA. Once it will in
2814 # the future, the following line could be removed (see issues
2815 # 6061, 6332 and following ones)
2816 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2817
2818 # this is not supported by the driver API yet
2819 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2820
2821 # Build
2822 # -----
2823
2824 # These hashes are needed for some ECDSA signature tests.
2825 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2826 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2827 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2828
Valerio Settiac7a8092023-10-31 12:23:44 +01002829 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002830
2831 # We expect ECDH to be re-enabled for the missing curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002832 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002833 # We expect ECP to be re-enabled, however the parts specific to the
2834 # families of curves that are accelerated should be ommited.
2835 # - functions with mxz in the name are specific to Montgomery curves
2836 # - ecp_muladd is specific to Weierstrass curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002837 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002838 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002839 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2840 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002841 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002842 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2843 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002844 fi
2845 # We expect ECDSA and ECJPAKE to be re-enabled only when
2846 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002847 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002848 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2849 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002850 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002851 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2852 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002853 fi
2854
2855 # Run the tests
2856 # -------------
2857
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002858 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2859 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002860}
2861
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002862component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002863 common_test_psa_crypto_config_accel_ecc_some_curves 1
2864}
2865
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002866component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002867 common_test_psa_crypto_config_accel_ecc_some_curves 0
2868}
2869
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002870# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2871# ECDH, ECDSA) with and without drivers.
2872# The input parameter is a boolean value which indicates:
2873# - 0 keep built-in EC algs,
2874# - 1 exclude built-in EC algs (driver only).
2875#
2876# This is used by the two following components to ensure they always use the
2877# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002878# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2879# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002880# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002881config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002882 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002883 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002884 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002885 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002886 # Disable modules that are accelerated
2887 scripts/config.py unset MBEDTLS_ECDSA_C
2888 scripts/config.py unset MBEDTLS_ECDH_C
2889 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002890 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002891 fi
2892
2893 # Restartable feature is not yet supported by PSA. Once it will in
2894 # the future, the following line could be removed (see issues
2895 # 6061, 6332 and following ones)
2896 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002897}
2898
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002899# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2900component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002901 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002902
2903 # Algorithms and key types to accelerate
2904 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2905 ALG_ECDH \
2906 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002907 $(helper_get_psa_key_type_list "ECC") \
2908 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002909
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002910 # Configure
2911 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002912
2913 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002914 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002915
Valerio Setti0a342c92023-09-01 09:12:31 +02002916 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002917 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2918 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002919
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002920 # Build
2921 # -----
2922
2923 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002924 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2925 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002926 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2927
Valerio Setti3fe105b2023-10-30 11:08:12 +01002928 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002929
2930 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002931 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
2932 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2933 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
2934 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002935
2936 # Run the tests
2937 # -------------
2938
Gilles Peskine14302ed2023-07-19 19:30:04 +02002939 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002940 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002941
Gilles Peskine14302ed2023-07-19 19:30:04 +02002942 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002943 tests/ssl-opt.sh
2944}
2945
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002946# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2947component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002948 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002949
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002950 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002951
Gilles Peskine21570cf2023-12-22 11:49:50 +01002952 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002953
Gilles Peskine14302ed2023-07-19 19:30:04 +02002954 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002955 make test
2956
Gilles Peskine14302ed2023-07-19 19:30:04 +02002957 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002958 tests/ssl-opt.sh
2959}
2960
Valerio Settie618cb02023-04-12 14:59:16 +02002961# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002962# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2963# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002964# to ensure that both tests use the same underlying configuration when testing
2965# driver's coverage with analyze_outcomes.py.
2966#
2967# This functions accepts 1 boolean parameter as follows:
2968# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2969# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2970# - 0: include built-in implementation of EC algorithms.
2971#
2972# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2973# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002974config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002975 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002976 # start with full config for maximum coverage (also enables USE_PSA)
2977 helper_libtestdriver1_adjust_config "full"
2978
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002979 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002980 # Disable modules that are accelerated
2981 scripts/config.py unset MBEDTLS_ECDSA_C
2982 scripts/config.py unset MBEDTLS_ECDH_C
2983 scripts/config.py unset MBEDTLS_ECJPAKE_C
2984 # Disable ECP module (entirely)
2985 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002986 fi
2987
Valerio Settiaecd32c2023-06-14 10:42:31 +02002988 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2989 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002990 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002991 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002992
Valerio Settie618cb02023-04-12 14:59:16 +02002993 # Restartable feature is not yet supported by PSA. Once it will in
2994 # the future, the following line could be removed (see issues
2995 # 6061, 6332 and following ones)
2996 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002997}
2998
2999# Build and test a configuration where driver accelerates all EC algs while
3000# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3001# side.
3002#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003003# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3004component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003005 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003006
3007 # Algorithms and key types to accelerate
3008 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3009 ALG_ECDH \
3010 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003011 $(helper_get_psa_key_type_list "ECC") \
3012 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003013
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003014 # Configure
3015 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003016
Valerio Settie618cb02023-04-12 14:59:16 +02003017 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003018 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003019 # Disable all the builtin curves. All the required algs are accelerated.
3020 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003021
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003022 # Build
3023 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003024
3025 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003026 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3027 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3028 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003029
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003030 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003031
Valerio Setti3fe105b2023-10-30 11:08:12 +01003032 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003033
3034 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003035 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3036 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3037 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003038 # Also ensure that ECP module was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003039 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003040
3041 # Run the tests
3042 # -------------
3043
Gilles Peskine14302ed2023-07-19 19:30:04 +02003044 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003045 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003046
Gilles Peskine14302ed2023-07-19 19:30:04 +02003047 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003048 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003049}
3050
3051# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003052# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003053# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003054component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003055 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003056
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003057 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003058
Gilles Peskine21570cf2023-12-22 11:49:50 +01003059 make
Valerio Settie618cb02023-04-12 14:59:16 +02003060
Gilles Peskine14302ed2023-07-19 19:30:04 +02003061 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003062 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003063
Gilles Peskine14302ed2023-07-19 19:30:04 +02003064 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003065 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003066}
3067
Valerio Setti4e2f2442023-08-15 10:10:26 +02003068# This is a common configuration helper used directly from:
3069# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3070# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3071# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003072# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003073# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003074# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003075# - this is the reference component of the above
3076# - it still disables RSA and FFDH, but it uses builtin EC algs
3077# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3078# - accelerate all EC and FFDH algs, disable only RSA
3079# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3080# - this is the reference component of the above
3081# - it still disables RSA, but it uses builtin EC and FFDH algs
3082#
3083# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003084# $1: a boolean value which states if we are testing an accelerated scenario
3085# or not.
3086# $2: a string value which states which components are tested. Allowed values
3087# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003088config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003089 driver_only="$1"
3090 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003091 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003092 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003093
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003094 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003095 # Disable modules that are accelerated
3096 scripts/config.py unset MBEDTLS_ECDSA_C
3097 scripts/config.py unset MBEDTLS_ECDH_C
3098 scripts/config.py unset MBEDTLS_ECJPAKE_C
3099 # Disable ECP module (entirely)
3100 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003101 # Also disable bignum
3102 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003103 fi
3104
3105 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3106 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3107 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3108 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3109
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003110 # RSA support is intentionally disabled on this test because RSA_C depends
3111 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003112 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3113 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 +02003114 scripts/config.py unset MBEDTLS_RSA_C
3115 scripts/config.py unset MBEDTLS_PKCS1_V15
3116 scripts/config.py unset MBEDTLS_PKCS1_V21
3117 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3118 # Also disable key exchanges that depend on RSA
3119 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3120 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3121 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3122 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3123 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3124
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003125 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003126 # When testing ECC only, we disable FFDH support, both from builtin and
3127 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003128 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003129 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 +01003130 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003131 scripts/config.py unset MBEDTLS_DHM_C
3132 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3133 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3134 else
3135 # When testing ECC and DH instead, we disable DHM and depending key
3136 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003137 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003138 scripts/config.py unset MBEDTLS_DHM_C
3139 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3140 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3141 fi
3142 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003143
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003144 # Restartable feature is not yet supported by PSA. Once it will in
3145 # the future, the following line could be removed (see issues
3146 # 6061, 6332 and following ones)
3147 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3148}
3149
Valerio Setti4e2f2442023-08-15 10:10:26 +02003150# Common helper used by:
3151# - component_test_psa_crypto_config_accel_ecc_no_bignum
3152# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003153#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003154# The goal is to build and test accelerating either:
3155# - ECC only or
3156# - both ECC and FFDH
3157#
3158# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003159# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3160# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003161common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003162 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003163
Valerio Setti5dfaca42023-09-05 08:48:51 +02003164 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003165 if [ "$test_target" = "ECC_DH" ]; then
3166 accel_text="ECC/FFDH"
3167 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003168 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003169 accel_text="ECC"
3170 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003171 fi
3172
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003173 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003174
3175 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003176 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3177 ALG_ECDH \
3178 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003179 $(helper_get_psa_key_type_list "ECC") \
3180 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003181 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003182 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003183 loc_accel_list="$loc_accel_list \
3184 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003185 $(helper_get_psa_key_type_list "DH") \
3186 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003187 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003188
3189 # Configure
3190 # ---------
3191
3192 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003193 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003194 # Disable all the builtin curves. All the required algs are accelerated.
3195 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003196
3197 # Build
3198 # -----
3199
3200 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003201 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3202 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3203 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003204
3205 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3206
Valerio Setti3fe105b2023-10-30 11:08:12 +01003207 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003208
3209 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003210 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3211 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3212 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003213 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003214 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3215 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3216 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
3217 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003218
3219 # Run the tests
3220 # -------------
3221
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003222 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003223
Gilles Peskine21570cf2023-12-22 11:49:50 +01003224 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003225
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003226 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003227 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003228}
3229
Valerio Setti4e2f2442023-08-15 10:10:26 +02003230# Common helper used by:
3231# - component_test_psa_crypto_config_reference_ecc_no_bignum
3232# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3233#
3234# The goal is to build and test a reference scenario (i.e. with builtin
3235# components) compared to the ones used in
3236# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3237#
3238# It is meant to be used in conjunction with
3239# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3240# coverage analysis in "analyze_outcomes.py" script.
3241common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003242 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003243
Valerio Setti5dfaca42023-09-05 08:48:51 +02003244 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003245 if [ "$test_target" = "ECC_DH" ]; then
3246 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003247 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003248 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003249 fi
3250
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003251 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003252
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003253 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003254
Gilles Peskine21570cf2023-12-22 11:49:50 +01003255 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003256
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003257 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003258 make test
3259
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003260 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003261 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003262}
3263
Valerio Setti4e2f2442023-08-15 10:10:26 +02003264component_test_psa_crypto_config_accel_ecc_no_bignum () {
3265 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3266}
3267
3268component_test_psa_crypto_config_reference_ecc_no_bignum () {
3269 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3270}
3271
3272component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3273 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3274}
3275
3276component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3277 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3278}
3279
Valerio Settiac6d35f2023-08-04 12:49:11 +02003280# Helper for setting common configurations between:
3281# - component_test_tfm_config_p256m_driver_accel_ec()
3282# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003283common_tfm_config () {
3284 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003285 cp configs/config-tfm.h "$CONFIG_H"
3286 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3287 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003288
Yanray Wang73bb2312023-09-25 11:21:15 +08003289 # Other config adjustment to make the tests pass.
3290 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003291 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003292 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3293 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003294
Yanray Wang73bb2312023-09-25 11:21:15 +08003295 # Config adjustment for better test coverage in our environment.
3296 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003297 #
3298 # Enable filesystem I/O for the benefit of PK parse/write tests.
3299 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3300}
3301
Valerio Settiac6d35f2023-08-04 12:49:11 +02003302# Keep this in sync with component_test_tfm_config() as they are both meant
3303# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003304component_test_tfm_config_p256m_driver_accel_ec () {
3305 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3306
3307 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003308
Dave Rodgman897bb772023-11-15 16:34:20 +00003309 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003310 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003311
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003312 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003313 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3314 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3315 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib7e95442023-03-21 11:52:33 +01003316 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003317 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3318 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3319 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
3320 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003321 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003322 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003323
Valerio Setti5e18b902023-12-04 12:07:30 +01003324 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3325 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003326 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003327
Valerio Settib7e95442023-03-21 11:52:33 +01003328 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003329 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003330 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003331}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003332
Valerio Settiac6d35f2023-08-04 12:49:11 +02003333# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3334# they are both meant to be used in analyze_outcomes.py for driver's coverage
3335# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003336component_test_tfm_config() {
3337 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003338
Dave Rodgman897bb772023-11-15 16:34:20 +00003339 # Disable P256M driver, which is on by default, so that analyze_outcomes
3340 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3341 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3342
Valerio Setti52ba0e32023-08-04 12:43:03 +02003343 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003344 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003345
Dave Rodgman897bb772023-11-15 16:34:20 +00003346 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003347 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003348
Valerio Setti5e18b902023-12-04 12:07:30 +01003349 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3350 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003351 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003352
Valerio Setti52ba0e32023-08-04 12:43:03 +02003353 msg "test: TF-M config"
3354 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003355}
3356
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003357# Common helper for component_full_without_ecdhe_ecdsa() and
3358# component_full_without_ecdhe_ecdsa_and_tls13() which:
3359# - starts from the "full" configuration minus the list of symbols passed in
3360# as 1st parameter
3361# - build
3362# - test only TLS (i.e. test_suite_tls and ssl-opt)
3363build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003364 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003365
3366 msg "build: full minus something, test TLS"
3367
3368 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003369 for sym in $symbols_to_disable; do
3370 echo "Disabling $sym"
3371 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003372 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003373
Gilles Peskine21570cf2023-12-22 11:49:50 +01003374 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003375
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003376 msg "test: full minus something, test TLS"
3377 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003378
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003379 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003380 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003381}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003382
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003383component_full_without_ecdhe_ecdsa () {
3384 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003385}
3386
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003387component_full_without_ecdhe_ecdsa_and_tls13 () {
3388 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3389 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003390}
3391
Valerio Setti249b18a2023-06-20 12:08:30 +02003392# This is an helper used by:
3393# - component_test_psa_ecc_key_pair_no_derive
3394# - component_test_psa_ecc_key_pair_no_generate
3395# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3396# enabled, but one. Input arguments are as follows:
3397# - $1 is the key type under test, i.e. ECC/RSA/DH
3398# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003399build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003400 key_type=$1
3401 unset_option=$2
3402 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003403
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003404 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003405 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003406 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3407 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3408
3409 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3410 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003411 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003412
Gilles Peskine21570cf2023-12-22 11:49:50 +01003413 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003414
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003415 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003416 make test
3417}
3418
3419component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003420 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003421}
3422
3423component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003424 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003425}
3426
Pengyu Lve705f572023-12-06 16:38:15 +08003427config_psa_crypto_accel_rsa () {
3428 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003429
Pengyu Lve705f572023-12-06 16:38:15 +08003430 # Start from crypto_full config (no X.509, no TLS)
3431 helper_libtestdriver1_adjust_config "crypto_full"
3432
3433 if [ "$driver_only" -eq 1 ]; then
3434 # Remove RSA support and its dependencies
3435 scripts/config.py unset MBEDTLS_RSA_C
3436 scripts/config.py unset MBEDTLS_PKCS1_V15
3437 scripts/config.py unset MBEDTLS_PKCS1_V21
3438
3439 # We need PEM parsing in the test library as well to support the import
3440 # of PEM encoded RSA keys.
3441 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3442 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3443 fi
3444}
3445
3446component_test_psa_crypto_config_accel_rsa_crypto () {
3447 msg "build: crypto_full with accelerated RSA"
3448
3449 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3450 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3451 KEY_TYPE_RSA_PUBLIC_KEY \
3452 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3453 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3454 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3455 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003456
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003457 # Configure
3458 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003459
Pengyu Lve705f572023-12-06 16:38:15 +08003460 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003461
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003462 # Build
3463 # -----
3464
Pengyu Lve705f572023-12-06 16:38:15 +08003465 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003466 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 +08003467 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003468 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003469
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003470 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003471
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003472 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003473 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003474
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003475 # Run the tests
3476 # -------------
3477
Pengyu Lve705f572023-12-06 16:38:15 +08003478 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003479 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003480}
3481
3482component_test_psa_crypto_config_reference_rsa_crypto () {
3483 msg "build: crypto_full with non-accelerated RSA"
3484
3485 # Configure
3486 # ---------
3487 config_psa_crypto_accel_rsa 0
3488
3489 # Build
3490 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003491 make
Pengyu Lve705f572023-12-06 16:38:15 +08003492
3493 # Run the tests
3494 # -------------
3495 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003496 make test
3497}
3498
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003499# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003500# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003501component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003502 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003503
Valerio Setti4590bc22023-06-13 15:39:23 +02003504 # Create a temporary output file unless there is already one set
3505 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3506 REMOVE_OUTCOME_ON_EXIT="no"
3507 else
3508 REMOVE_OUTCOME_ON_EXIT="yes"
3509 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3510 export MBEDTLS_TEST_OUTCOME_FILE
3511 fi
3512
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003513 # Start from crypto configuration
3514 scripts/config.py crypto
3515
3516 # Remove RSA support and its dependencies
3517 scripts/config.py unset MBEDTLS_PKCS1_V15
3518 scripts/config.py unset MBEDTLS_PKCS1_V21
3519 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3520 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3521 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3522 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3523 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3524 scripts/config.py unset MBEDTLS_RSA_C
3525 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3526
3527 # Enable PSA support
3528 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3529
Valerio Setti01cc88a2023-06-15 11:53:08 +02003530 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003531 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003532 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3533 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3534 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003535
3536 make
3537
Valerio Setti01cc88a2023-06-15 11:53:08 +02003538 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003539 make test
3540
3541 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3542 # performing RSA signature.
3543 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3544 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3545
3546 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3547 rm $MBEDTLS_TEST_OUTCOME_FILE
3548 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003549}
3550
Ronald Cronb2312452021-05-08 14:32:59 +02003551component_test_psa_crypto_config_accel_hash () {
3552 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3553
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003554 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3555 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3556 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003557
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003558 # Configure
3559 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003560
Ronald Cron46ac0652024-03-18 12:39:04 +01003561 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003562 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003563
3564 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003565 scripts/config.py unset MBEDTLS_MD5_C
3566 scripts/config.py unset MBEDTLS_RIPEMD160_C
3567 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003568 scripts/config.py unset MBEDTLS_SHA224_C
3569 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003570 scripts/config.py unset MBEDTLS_SHA384_C
3571 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003572 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003573
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003574 # Build
3575 # -----
3576
3577 helper_libtestdriver1_make_drivers "$loc_accel_list"
3578
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003579 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003580
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003581 # There's a risk of something getting re-enabled via config_psa.h;
3582 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003583 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3584 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3585 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3586 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3587 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003588
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003589 # Run the tests
3590 # -------------
3591
Ronald Cronb2312452021-05-08 14:32:59 +02003592 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3593 make test
3594}
3595
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003596# Auxiliary function to build config for hashes with and without drivers
3597config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003598 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003599 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003600 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003601 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003602 # disable the built-in implementation of hashes
3603 scripts/config.py unset MBEDTLS_MD5_C
3604 scripts/config.py unset MBEDTLS_RIPEMD160_C
3605 scripts/config.py unset MBEDTLS_SHA1_C
3606 scripts/config.py unset MBEDTLS_SHA224_C
3607 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003608 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003609 scripts/config.py unset MBEDTLS_SHA384_C
3610 scripts/config.py unset MBEDTLS_SHA512_C
3611 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003612 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003613 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003614}
3615
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003616# Note that component_test_psa_crypto_config_reference_hash_use_psa
3617# is related to this component and both components need to be kept in sync.
3618# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003619component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003620 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003621
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003622 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3623 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3624 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003625
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003626 # Configure
3627 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003628
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003629 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003630
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003631 # Build
3632 # -----
3633
3634 helper_libtestdriver1_make_drivers "$loc_accel_list"
3635
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003636 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003637
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003638 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003639 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003640 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3641 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3642 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3643 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3644 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003645
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003646 # Run the tests
3647 # -------------
3648
Gilles Peskine14302ed2023-07-19 19:30:04 +02003649 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003650 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003651
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003652 # This is mostly useful so that we can later compare outcome files with
3653 # the reference config in analyze_outcomes.py, to check that the
3654 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003655 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003656 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003657
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003658 # This is to make sure all ciphersuites are exercised, but we don't need
3659 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003660 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003661 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003662}
3663
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003664# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3665# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3666# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3667# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003668component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003669 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003670
3671 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003672
Gilles Peskine21570cf2023-12-22 11:49:50 +01003673 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003674
Gilles Peskine14302ed2023-07-19 19:30:04 +02003675 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003676 make test
3677
Gilles Peskine14302ed2023-07-19 19:30:04 +02003678 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003679 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003680}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003681
Valerio Setti8eb310c2024-01-22 16:22:57 +01003682# Auxiliary function to build config for hashes with and without drivers
3683config_psa_crypto_hmac_use_psa () {
3684 driver_only="$1"
3685 # start with config full for maximum coverage (also enables USE_PSA)
3686 helper_libtestdriver1_adjust_config "full"
3687
Valerio Setticd89b0b2024-01-24 14:24:55 +01003688 if [ "$driver_only" -eq 1 ]; then
3689 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3690 # is still enabled though (for ENTROPY_C among others).
3691 scripts/config.py unset MBEDTLS_MD_C
3692 # Disable also the builtin hashes since they are supported by the driver
3693 # and MD module is able to perform PSA dispathing.
3694 scripts/config.py unset-all MBEDTLS_SHA
3695 scripts/config.py unset MBEDTLS_MD5_C
3696 scripts/config.py unset MBEDTLS_RIPEMD160_C
3697 fi
3698
Valerio Setti8eb310c2024-01-22 16:22:57 +01003699 # Direct dependencies of MD_C. We disable them also in the reference
3700 # component to work with the same set of features.
3701 scripts/config.py unset MBEDTLS_PKCS7_C
3702 scripts/config.py unset MBEDTLS_PKCS5_C
3703 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3704 scripts/config.py unset MBEDTLS_HKDF_C
3705 # Dependencies of HMAC_DRBG
3706 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3707 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3708}
3709
3710component_test_psa_crypto_config_accel_hmac() {
3711 msg "test: full with accelerated hmac"
3712
3713 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3714 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3715 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3716 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3717
3718 # Configure
3719 # ---------
3720
3721 config_psa_crypto_hmac_use_psa 1
3722
Valerio Setti8eb310c2024-01-22 16:22:57 +01003723 # Build
3724 # -----
3725
3726 helper_libtestdriver1_make_drivers "$loc_accel_list"
3727
3728 helper_libtestdriver1_make_main "$loc_accel_list"
3729
3730 # Ensure that built-in support for HMAC is disabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003731 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
Valerio Setti8eb310c2024-01-22 16:22:57 +01003732
3733 # Run the tests
3734 # -------------
3735
3736 msg "test: full with accelerated hmac"
3737 make test
3738}
3739
3740component_test_psa_crypto_config_reference_hmac() {
3741 msg "test: full without accelerated hmac"
3742
3743 config_psa_crypto_hmac_use_psa 0
3744
3745 make
3746
3747 msg "test: full without accelerated hmac"
3748 make test
3749}
3750
Valerio Setti9da01a72023-12-18 17:38:18 +01003751component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003752 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003753
Valerio Setti9da01a72023-12-18 17:38:18 +01003754 # Albeit this components aims at accelerating DES which should only support
3755 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3756 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003757 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3758 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3759 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003760
Valerio Setti9da01a72023-12-18 17:38:18 +01003761 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3762 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3763 # of this component. This limitation will be addressed by #8598.
3764
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003765 # Configure
3766 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003767
Valerio Setti9a427302023-10-17 11:40:42 +02003768 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003769 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003770
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003771 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003772 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3773 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3774 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3775 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3776 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3777 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3778 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003779 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003780
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003781 # Build
3782 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003783
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003784 helper_libtestdriver1_make_drivers "$loc_accel_list"
3785
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003786 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003787
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003788 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003789 not grep mbedtls_des* ${BUILTIN_SRC_PATH}/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003790
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003791 # Run the tests
3792 # -------------
3793
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003794 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003795 make test
3796}
3797
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003798component_test_psa_crypto_config_accel_aead () {
3799 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3800
Valerio Setti3f02bb72023-10-02 15:57:33 +02003801 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3802 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003803
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003804 # Configure
3805 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003806
Valerio Setti3f02bb72023-10-02 15:57:33 +02003807 # Start from full config
3808 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003809
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003810 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003811 scripts/config.py unset MBEDTLS_GCM_C
3812 scripts/config.py unset MBEDTLS_CCM_C
3813 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003814
Valerio Settia50b89e2023-11-08 15:58:47 +01003815 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3816 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003817
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003818 # Build
3819 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003820
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003821 helper_libtestdriver1_make_drivers "$loc_accel_list"
3822
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003823 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003824
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003825 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003826 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3827 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3828 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
Przemek Stekielee1bb412022-10-11 11:52:25 +02003829
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003830 # Run the tests
3831 # -------------
3832
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003833 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3834 make test
3835}
3836
Valerio Settib680fc42023-10-13 09:29:37 +02003837# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003838# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3839# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3840common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003841 # Start from the full config
3842 helper_libtestdriver1_adjust_config "full"
3843
Valerio Settib680fc42023-10-13 09:29:37 +02003844 scripts/config.py unset MBEDTLS_NIST_KW_C
3845}
3846
Valerio Settib6b301f2023-10-04 12:05:05 +02003847# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003848# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3849# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003850# are meant to be used together in analyze_outcomes.py script in order to test
3851# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003852component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3853 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003854
Valerio Settiad8b7f02023-10-25 12:39:50 +02003855 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 +01003856 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003857 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003858 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3859
3860 # Configure
3861 # ---------
3862
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003863 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003864
3865 # Disable the things that are being accelerated
3866 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3867 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3868 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3869 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3870 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3871 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3872 scripts/config.py unset MBEDTLS_GCM_C
3873 scripts/config.py unset MBEDTLS_CCM_C
3874 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003875 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003876 scripts/config.py unset MBEDTLS_DES_C
3877 scripts/config.py unset MBEDTLS_AES_C
3878 scripts/config.py unset MBEDTLS_ARIA_C
3879 scripts/config.py unset MBEDTLS_CHACHA20_C
3880 scripts/config.py unset MBEDTLS_CAMELLIA_C
3881
Valerio Settiec9b2582023-11-08 16:50:54 +01003882 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3883 # does not depend on it.
3884 scripts/config.py unset MBEDTLS_CIPHER_C
3885
Valerio Settib6b301f2023-10-04 12:05:05 +02003886 # Build
3887 # -----
3888
3889 helper_libtestdriver1_make_drivers "$loc_accel_list"
3890
3891 helper_libtestdriver1_make_main "$loc_accel_list"
3892
3893 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003894 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
3895 not grep mbedtls_des ${BUILTIN_SRC_PATH}/des.o
3896 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
3897 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
3898 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
3899 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3900 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3901 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
3902 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003903
3904 # Run the tests
3905 # -------------
3906
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003907 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003908 make test
Valerio Settif9414552023-11-09 10:43:20 +01003909
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003910 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003911 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003912
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003913 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003914 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003915}
3916
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003917component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3918 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3919 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003920
Gilles Peskine21570cf2023-12-22 11:49:50 +01003921 make
Valerio Settif9414552023-11-09 10:43:20 +01003922
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003923 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003924 make test
Valerio Settif9414552023-11-09 10:43:20 +01003925
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003926 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003927 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003928
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003929 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003930 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003931}
3932
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003933common_block_cipher_dispatch() {
3934 TEST_WITH_DRIVER="$1"
3935
3936 # Start from the full config
3937 helper_libtestdriver1_adjust_config "full"
3938
3939 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3940 # Disable key types that are accelerated (there is no legacy equivalent
3941 # symbol for ECB)
3942 scripts/config.py unset MBEDTLS_AES_C
3943 scripts/config.py unset MBEDTLS_ARIA_C
3944 scripts/config.py unset MBEDTLS_CAMELLIA_C
3945 fi
3946
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003947 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003948 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003949 # Keep this also in the reference component in order to skip the same tests
3950 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003951 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
3952 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
3953 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
3954 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
3955 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
3956 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
3957 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02003958 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003959
3960 # Disable direct dependency on AES_C
3961 scripts/config.py unset MBEDTLS_NIST_KW_C
3962
3963 # Prevent the cipher module from using deprecated PSA path. The reason is
3964 # that otherwise there will be tests relying on "aes_info" (defined in
3965 # "cipher_wrap.c") whose functions are not available when AES_C is
3966 # not defined. ARIA and Camellia are not a problem in this case because
3967 # the PSA path is not tested for these key types.
3968 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
3969}
3970
Valerio Settif8e6cba2023-12-12 11:53:39 +01003971component_test_full_block_cipher_psa_dispatch () {
3972 msg "build: full + PSA dispatch in block_cipher"
3973
3974 loc_accel_list="ALG_ECB_NO_PADDING \
3975 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
3976
3977 # Configure
3978 # ---------
3979
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003980 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01003981
Valerio Settif8e6cba2023-12-12 11:53:39 +01003982 # Build
3983 # -----
3984
3985 helper_libtestdriver1_make_drivers "$loc_accel_list"
3986
3987 helper_libtestdriver1_make_main "$loc_accel_list"
3988
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003989 # Make sure disabled components were not re-enabled by accident (additive
3990 # config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003991 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
3992 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
3993 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003994
Valerio Settif8e6cba2023-12-12 11:53:39 +01003995 # Run the tests
3996 # -------------
3997
3998 msg "test: full + PSA dispatch in block_cipher"
3999 make test
4000}
4001
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004002# This is the reference component of component_test_full_block_cipher_psa_dispatch
4003component_test_full_block_cipher_legacy_dispatch () {
4004 msg "build: full + legacy dispatch in block_cipher"
4005
4006 common_block_cipher_dispatch 0
4007
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004008 make
4009
4010 msg "test: full + legacy dispatch in block_cipher"
4011 make test
4012}
4013
Gilles Peskine36dea152023-07-20 22:19:45 +02004014component_test_aead_chachapoly_disabled() {
4015 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004016 scripts/config.py full
4017 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004018 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004019 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004020
Gilles Peskine36dea152023-07-20 22:19:45 +02004021 msg "test: full minus CHACHAPOLY"
4022 make test
4023}
4024
4025component_test_aead_only_ccm() {
4026 msg "build: full minus CHACHAPOLY and GCM"
4027 scripts/config.py full
4028 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4029 scripts/config.py unset MBEDTLS_GCM_C
4030 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4031 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004032 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004033
4034 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004035 make test
4036}
4037
Ronald Crone501d0e2023-07-10 08:31:19 +02004038component_test_ccm_aes_sha256() {
4039 msg "build: CCM + AES + SHA256 configuration"
4040
Ronald Cron7612d8c2023-07-20 10:03:54 +02004041 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004042 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004043
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004044 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004045
4046 msg "test: CCM + AES + SHA256 configuration"
4047 make test
4048}
4049
Dave Rodgman904c5892023-06-28 17:36:02 +01004050support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004051 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004052}
4053
Dave Rodgman904c5892023-06-28 17:36:02 +01004054component_build_tfm_armcc() {
4055 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004056 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004057
Dave Rodgman88651c42023-06-29 12:35:51 +01004058 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004059 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 +01004060}
4061
4062component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004063 # Check that the TF-M configuration can build cleanly with various
4064 # warning flags enabled. We don't build or run tests, since the
4065 # TF-M configuration needs a TF-M platform. A tweaked version of
4066 # the configuration that works on mainstream platforms is in
4067 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004068 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004069
Dave Rodgman88651c42023-06-29 12:35:51 +01004070 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004071 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 +01004072
Dave Rodgman904c5892023-06-28 17:36:02 +01004073 msg "build: TF-M config, gcc native build"
4074 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004075 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 +01004076}
4077
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004078# Test that the given .o file builds with all (valid) combinations of the given options.
4079#
4080# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4081#
4082# The validator function is the name of a function to validate the combination of options.
4083# It may be "" if all combinations are valid.
4084# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004085# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004086build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004087 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004088 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004089 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004090 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004091 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004092
Dave Rodgman42436102023-10-03 15:47:05 +01004093 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004094 for opt in "${options[@]}"; do
4095 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004096 done
4097
Ronald Cron709bbf02024-07-03 07:59:30 +02004098 # enter the library directory
4099 cd library
Dave Rodgman42436102023-10-03 15:47:05 +01004100
Dave Rodgman920343a2023-10-01 18:41:09 +01004101 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004102 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 +01004103
Dave Rodgman42436102023-10-03 15:47:05 +01004104 # Extract the command generated by the Makefile to build the target file.
4105 # This ensures that we have any include paths, macro definitions, etc
4106 # that may be applied by make.
4107 # 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 +01004108 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004109
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004110 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004111 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004112
Dave Rodgman28e38d82023-10-04 11:50:30 +01004113 len=${#options[@]}
Ronald Cron709bbf02024-07-03 07:59:30 +02004114 source_file=../${file%.o}.c
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004115
4116 targets=0
4117 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004118
Dave Rodgman28e38d82023-10-04 11:50:30 +01004119 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004120 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004121 # each bit of $i is used to determine if options[i] will be set or not
4122 target="t"
4123 clang_args=""
4124 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004125 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004126 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004127 clang_args="${clang_args} ${opt}"
4128 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004129 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004130 done
4131
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004132 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004133 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004134 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004135 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004136
Dave Rodgman28e38d82023-10-04 11:50:30 +01004137 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004138 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004139 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004140 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004141
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004142 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004143
Dave Rodgman920343a2023-10-01 18:41:09 +01004144 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004145 make -s -f ${makefile} build_test_config_combos
4146 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004147
4148 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004149 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004150}
4151
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004152validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004153 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004154 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4155 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004156 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004157 fi
4158 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004159 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004160}
4161
4162component_build_aes_variations() {
4163 # 18s - around 90ms per clang invocation on M1 Pro
4164 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004165 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004166 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004167
Yanray Wangbc29aef2023-11-06 11:08:17 +08004168 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004169 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004170
Ronald Cron709bbf02024-07-03 07:59:30 +02004171 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004172 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4173 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004174 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004175 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004176
4177 cd "$MBEDTLS_ROOT_DIR"
4178 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4179
Yanray Wang42be1ba2023-11-23 14:28:47 +08004180 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004181 # manually set or unset those configurations to check
4182 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004183 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4184 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4185 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4186 scripts/config.py unset MBEDTLS_DES_C
4187 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron709bbf02024-07-03 07:59:30 +02004188 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004189 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4190 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004191 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004192 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004193}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004194
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004195component_test_no_platform () {
4196 # Full configuration build, without platform support, file IO and net sockets.
4197 # This should catch missing mbedtls_printf definitions, and by disabling file
4198 # IO, it should catch missing '#include <stdio.h>'
4199 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004200 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004201 scripts/config.py unset MBEDTLS_PLATFORM_C
4202 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004203 scripts/config.py unset MBEDTLS_FS_IO
4204 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004205 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004206 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004207 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004208 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004209 # to re-enable platform integration features otherwise disabled in C99 builds
4210 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004211 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004212}
Gilles Peskine7c652162017-12-11 00:01:40 +01004213
4214component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004215 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004216 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4217 scripts/config.py full
4218 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004219 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4220 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4221 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4222 make
4223}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004224
Gilles Peskine8f073122018-11-27 15:58:47 +01004225component_build_no_ssl_srv () {
4226 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004227 scripts/config.py full
4228 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004229 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004230}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004231
Gilles Peskine8f073122018-11-27 15:58:47 +01004232component_build_no_ssl_cli () {
4233 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004234 scripts/config.py full
4235 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004236 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004237}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004238
Gilles Peskine8f073122018-11-27 15:58:47 +01004239component_build_no_sockets () {
4240 # Note, C99 compliance can also be tested with the sockets support disabled,
4241 # as that requires a POSIX platform (which isn't the same as C99).
4242 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004243 scripts/config.py full
4244 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4245 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4246 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4247}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004248
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004249component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004250 msg "build: default config with memory buffer allocator and backtrace enabled"
4251 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4252 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4253 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004254 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004255 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004256 make
4257
4258 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4259 make test
4260}
4261
4262component_test_memory_buffer_allocator () {
4263 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004264 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4265 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004266 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004267 make
4268
4269 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4270 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004271
4272 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4273 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004274 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004275}
4276
Gilles Peskine8f073122018-11-27 15:58:47 +01004277component_test_no_max_fragment_length () {
4278 # Run max fragment length tests with MFL disabled
4279 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004280 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004281 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004282 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004283
Gilles Peskine8f073122018-11-27 15:58:47 +01004284 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004285 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004286}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004287
Hanno Becker545ced42019-02-19 11:10:48 +00004288component_test_asan_remove_peer_certificate () {
4289 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004290 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004291 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004292 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004293 make
4294
4295 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4296 make test
4297
4298 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004299 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004300
4301 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004302 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004303
4304 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004305 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004306}
4307
Gilles Peskine8f073122018-11-27 15:58:47 +01004308component_test_no_max_fragment_length_small_ssl_out_content_len () {
4309 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004310 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4311 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4312 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004313 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004314 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004315
Gilles Peskine8f073122018-11-27 15:58:47 +01004316 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004317 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004318
4319 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004320 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004321}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004322
Darryl Greenaad82f92019-12-02 10:53:11 +00004323component_test_variable_ssl_in_out_buffer_len () {
4324 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4325 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004326 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004327 make
4328
4329 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4330 make test
4331
4332 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004333 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004334
4335 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004336 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004337}
4338
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004339component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004340 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004341 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004342
Dave Rodgman17127e92023-12-14 16:42:48 +00004343 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004344 make
4345
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004346 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004347 make test
4348
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004349 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004350 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004351
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004352 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004353 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004354}
4355
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004356component_test_ssl_alloc_buffer_and_mfl () {
4357 msg "build: default config with memory buffer allocator and MFL extension"
4358 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4359 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4360 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4361 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4362 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004363 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004364 make
4365
4366 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4367 make test
4368
4369 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 +02004370 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004371}
4372
Gilles Peskine636c26a2020-03-04 20:46:15 +01004373component_test_when_no_ciphersuites_have_mac () {
4374 msg "build: when no ciphersuites have MAC"
Ronald Cron0417a2c2024-05-24 14:22:11 +02004375 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4376 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4377 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4378 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4379 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
4380
Gilles Peskine636c26a2020-03-04 20:46:15 +01004381 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004382 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004383 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron0417a2c2024-05-24 14:22:11 +02004384
Gilles Peskine636c26a2020-03-04 20:46:15 +01004385 make
4386
Ronald Croncd33cd62024-05-27 08:14:27 +02004387 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004388 make test
4389
Ronald Croncd33cd62024-05-27 08:14:27 +02004390 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004391 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004392}
4393
Raoul Strackxa4e86142020-06-15 17:03:13 +02004394component_test_no_date_time () {
4395 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4396 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004397 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004398 make
4399
4400 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4401 make test
4402}
4403
Gilles Peskine8f073122018-11-27 15:58:47 +01004404component_test_platform_calloc_macro () {
4405 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004406 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4407 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4408 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004409 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004410 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004411
Gilles Peskine8f073122018-11-27 15:58:47 +01004412 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4413 make test
4414}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004415
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004416component_test_malloc_0_null () {
4417 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004418 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004419 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 +02004420
4421 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4422 make test
4423
4424 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4425 # Just the calloc selftest. "make test" ran the others as part of the
4426 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004427 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004428
4429 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4430 # Run a subset of the tests. The choice is a balance between coverage
4431 # and time (including time indirectly wasted due to flaky tests).
4432 # The current choice is to skip tests whose description includes
4433 # "proxy", which is an approximation of skipping tests that use the
4434 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004435 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004436}
4437
Dave Rodgman6a08b682023-06-19 11:51:33 +01004438support_test_aesni() {
4439 # Check that gcc targets x86_64 (we can build AESNI), and check for
4440 # AESNI support on the host (we can run AESNI).
4441 #
4442 # The name of this function is possibly slightly misleading, but needs to align
4443 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004444 #
4445 # In principle 32-bit x86 can support AESNI, but our implementation does not
4446 # support 32-bit x86, so we check for x86-64.
4447 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004448 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4449 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004450 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004451}
4452
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004453component_test_aesni () { # ~ 60s
4454 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4455 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4456 #
4457 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4458 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4459 # exercise the plain C impl).
4460
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004461 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004462 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004463 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004464 scripts/config.py set MBEDTLS_HAVE_ASM
4465
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004466 # test the intrinsics implementation
4467 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004468 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004469 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004470 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004471 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004472
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004473 # test the asm implementation
4474 msg "AES tests, test assembly"
4475 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004476 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004477 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004478 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004479
4480 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004481 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004482 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004483 msg "AES tests, plain C"
4484 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004485 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004486 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004487 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004488 not grep -q "AES note: using AESNI" ./programs/test/selftest
4489 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004490
4491 # test the intrinsics implementation
4492 scripts/config.py set MBEDTLS_AESNI_C
4493 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4494 msg "AES tests, test AESNI only"
4495 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004496 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004497 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4498 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004499 grep -q "AES note: using AESNI" ./programs/test/selftest
4500 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004501}
4502
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004503component_test_sha3_variations() {
4504 msg "sha3 loop unroll variations"
4505
4506 # define minimal config sufficient to test SHA3
4507 cat > include/mbedtls/mbedtls_config.h << END
4508 #define MBEDTLS_SELF_TEST
4509 #define MBEDTLS_SHA3_C
4510END
4511
4512 msg "all loops unrolled"
4513 make clean
4514 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"
4515 ./tests/test_suite_shax
4516
4517 msg "all loops rolled up"
4518 make clean
4519 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"
4520 ./tests/test_suite_shax
4521}
4522
Jerry Yub6d39c22023-08-16 15:11:48 +08004523support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004524 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004525}
4526
4527component_test_aesni_m32 () { # ~ 60s
4528 # This tests are duplicated from component_test_aesni for i386 target
4529 #
4530 # AESNI intrinsic code supports i386 and assembly code does not support it.
4531
4532 msg "build: default config with different AES implementations"
4533 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004534 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4535 scripts/config.py set MBEDTLS_HAVE_ASM
4536
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004537 # test the intrinsics implementation with gcc
4538 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004539 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004540 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004541 # check that we built intrinsics - this should be used by default when supported by the compiler
4542 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4543 grep -q "AES note: using AESNI" ./programs/test/selftest
4544 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004545 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4546
4547 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004548 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4549 msg "AES tests, test AESNI only"
4550 make clean
4551 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4552 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4553 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4554 grep -q "AES note: using AESNI" ./programs/test/selftest
4555 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004556 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4557}
4558
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004559support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004560 # clang >= 4 is required to build with target attributes
4561 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004562}
4563
4564component_test_aesni_m32_clang() {
4565
4566 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004567 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4568 scripts/config.py set MBEDTLS_HAVE_ASM
4569
4570 # test the intrinsics implementation with clang
4571 msg "AES tests, test intrinsics (clang)"
4572 make clean
4573 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4574 # check that we built intrinsics - this should be used by default when supported by the compiler
4575 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4576 grep -q "AES note: using AESNI" ./programs/test/selftest
4577 grep -q "AES note: built-in implementation." ./programs/test/selftest
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004578 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4579}
4580
Jerry Yu193cbc02023-08-03 17:06:29 +08004581# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4582component_build_aes_aesce_armcc () {
4583 msg "Build: AESCE test on arm64 platform without plain C."
4584 scripts/config.py baremetal
4585
4586 # armc[56] don't support SHA-512 intrinsics
4587 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4588
4589 # Stop armclang warning about feature detection for A64_CRYPTO.
4590 # With this enabled, the library does build correctly under armclang,
4591 # but in baremetal builds (as tested here), feature detection is
4592 # unavailable, and the user is notified via a #warning. So enabling
4593 # this feature would prevent us from building with -Werror on
4594 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004595 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004596 scripts/config.py set MBEDTLS_HAVE_ASM
4597
4598 msg "AESCE, build with default configuration."
4599 scripts/config.py set MBEDTLS_AESCE_C
4600 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4601 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4602
4603 msg "AESCE, build AESCE only"
4604 scripts/config.py set MBEDTLS_AESCE_C
4605 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4606 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4607}
4608
Dave Rodgman0c584032023-10-08 12:26:54 +01004609support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004610 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004611 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004612}
4613
4614component_build_aes_armce () {
4615 # Test variations of AES with Armv8 crypto extensions
4616 scripts/config.py set MBEDTLS_AESCE_C
4617 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4618
4619 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004620 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004621
4622 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004623 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004624
4625 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004626 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgman0c584032023-10-08 12:26:54 +01004627
Dave Rodgman5e419372023-10-23 15:30:20 +01004628 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004629
Dave Rodgman5e419372023-10-23 15:30:20 +01004630 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004631 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004632
Dave Rodgman5e419372023-10-23 15:30:20 +01004633 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004634 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004635
Dave Rodgman5e419372023-10-23 15:30:20 +01004636 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004637 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004638
4639 # test for presence of AES instructions
4640 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4641 msg "clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004642 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4643 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004644 msg "clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004645 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4646 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004647 msg "clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004648 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4649 grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004650
4651 # test for absence of AES instructions
4652 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4653 scripts/config.py unset MBEDTLS_AESCE_C
4654 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004655 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4656 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004657 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004658 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4659 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004660 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004661 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4662 not grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004663}
4664
Dave Rodgman9ed18532023-10-05 00:06:47 +01004665support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004666 # clang >= 4 is required to build with SHA extensions
4667 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004668}
4669
Dave Rodgmand9e80832023-10-04 17:17:46 +01004670component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004671 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004672
4673
4674 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004675 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004676 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004677 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004678 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004679 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004680 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004681
Dave Rodgmand9e80832023-10-04 17:17:46 +01004682
Dave Rodgman94a634d2023-10-10 12:59:29 +01004683 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004684 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004685 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004686 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004687 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004688
Dave Rodgman5b89c552023-10-10 14:59:02 +01004689 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004690 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004691 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004692 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004693
Dave Rodgmancd654002023-10-05 09:40:07 +01004694
Dave Rodgman94a634d2023-10-10 12:59:29 +01004695 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004696 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004697 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004698 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004699 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004700 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004701 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004702
Dave Rodgmancd654002023-10-05 09:40:07 +01004703
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004704 # examine the disassembly for presence of SHA instructions
4705 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4706 scripts/config.py set ${opt}
4707 msg "${opt} clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004708 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4709 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004710
4711 msg "${opt} clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004712 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4713 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004714
4715 msg "${opt} clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004716 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4717 grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004718 scripts/config.py unset ${opt}
4719 done
4720
4721
4722 # examine the disassembly for absence of SHA instructions
4723 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004724 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4725 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004726
4727 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004728 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4729 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004730
4731 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004732 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4733 not grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004734}
4735
Jerry Yu193cbc02023-08-03 17:06:29 +08004736support_build_aes_aesce_armcc () {
4737 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004738}
4739
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004740component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004741 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004742 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004743
Dave Rodgmand8d64512023-12-19 12:20:21 +00004744 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004745
4746 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4747 make test
4748}
4749
4750component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4751 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4752 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004753 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004754
Hanno Becker83ebf782017-07-07 12:29:15 +01004755 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004756
4757 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004758 make test
4759}
Gilles Peskine8f073122018-11-27 15:58:47 +01004760
Hanno Becker83ebf782017-07-07 12:29:15 +01004761component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004762 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4763 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004764 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004765 scripts/config.py unset MBEDTLS_AESCE_C
4766
Dave Rodgmand8d64512023-12-19 12:20:21 +00004767 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004768
4769 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004770 make test
4771
4772 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4773 programs/test/selftest
4774}
4775
Matthias Schulz0767fda2024-02-07 10:46:28 +01004776component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004777 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4778 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004779 scripts/config.py unset MBEDTLS_AESNI_C
4780 scripts/config.py unset MBEDTLS_AESCE_C
4781
4782 make CFLAGS='-O2 -Werror -Wall -Wextra'
4783
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004784 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004785 make test
4786}
4787
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004788component_test_aes_fewer_tables () {
4789 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004790 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004791 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004792
Gilles Peskine7c652162017-12-11 00:01:40 +01004793 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004794 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004795}
4796
4797component_test_aes_rom_tables () {
4798 msg "build: default config with AES_ROM_TABLES enabled"
4799 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004800 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004801
4802 msg "test: AES_ROM_TABLES"
4803 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004804}
4805
Gilles Peskine14c3c062018-01-29 21:25:12 +01004806component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004807 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4808 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4809 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004810 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004811
Gilles Peskine8f073122018-11-27 15:58:47 +01004812 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4813 make test
4814}
4815
Yanray Wang49cd4b52023-11-10 11:58:37 +08004816# helper for common_block_cipher_no_decrypt() which:
4817# - enable/disable the list of config options passed from -s/-u respectively.
4818# - build
4819# - test for tests_suite_xxx
4820# - selftest
4821#
4822# Usage: helper_block_cipher_no_decrypt_build_test
4823# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4824# Options: -s set_opts the list of config options to enable
4825# -u unset_opts the list of config options to disable
4826# -c cflags the list of options passed to CFLAGS
4827# -l ldflags the list of options passed to LDFLAGS
4828helper_block_cipher_no_decrypt_build_test () {
4829 while [ $# -gt 0 ]; do
4830 case "$1" in
4831 -s)
4832 shift; local set_opts="$1";;
4833 -u)
4834 shift; local unset_opts="$1";;
4835 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004836 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004837 -l)
4838 shift; local ldflags="$1";;
4839 esac
4840 shift
4841 done
4842 set_opts="${set_opts:-}"
4843 unset_opts="${unset_opts:-}"
4844 cflags="${cflags:-}"
4845 ldflags="${ldflags:-}"
4846
Yanray Wangb2d6e522023-11-13 16:57:47 +08004847 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4848 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004849
4850 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4851 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004852 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004853
4854 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004855 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4856 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4857 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004858 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004859 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004860 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
Ronald Cron709bbf02024-07-03 07:59:30 +02004861 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004862
4863 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4864 make test
4865
4866 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4867 programs/test/selftest
4868}
4869
4870# This is a common configuration function used in:
4871# - component_test_block_cipher_no_decrypt_aesni_legacy()
4872# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4873# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4874# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4875# on x86.
4876common_block_cipher_no_decrypt () {
4877 # test AESNI intrinsics
4878 helper_block_cipher_no_decrypt_build_test \
4879 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004880 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004881
4882 # test AESNI assembly
4883 helper_block_cipher_no_decrypt_build_test \
4884 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004885 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004886
4887 # test AES C implementation
4888 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004889 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004890
4891 # test AESNI intrinsics for i386 target
4892 helper_block_cipher_no_decrypt_build_test \
4893 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004894 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004895 -l "-m32"
4896}
4897
Yanray Wang3ae11992023-11-13 17:32:09 +08004898# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4899# usage: 0: no PSA crypto configuration
4900# 1: use PSA crypto configuration
4901config_block_cipher_no_decrypt () {
4902 use_psa=$1
4903
Yanray Wang66111392023-10-31 18:54:54 +08004904 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004905 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4906 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004907 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004908 scripts/config.py unset MBEDTLS_NIST_KW_C
4909
Yanray Wang3ae11992023-11-13 17:32:09 +08004910 if [ "$use_psa" -eq 1 ]; then
4911 # Enable support for cryptographic mechanisms through the PSA API.
4912 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4913 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4914 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4915 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4916 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4917 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4918 fi
4919}
4920
4921component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004922 # This consistently causes an llvm crash on clang 3.8, so use gcc
4923 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004924 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004925 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004926}
4927
Yanray Wangf1496402023-11-01 18:55:13 +08004928component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004929 # This consistently causes an llvm crash on clang 3.8, so use gcc
4930 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004931 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004932 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004933}
4934
Yanray Wang66111392023-10-31 18:54:54 +08004935support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004936 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08004937}
4938
Yanray Wang66111392023-10-31 18:54:54 +08004939component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08004940 scripts/config.py baremetal
4941
4942 # armc[56] don't support SHA-512 intrinsics
4943 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4944
4945 # Stop armclang warning about feature detection for A64_CRYPTO.
4946 # With this enabled, the library does build correctly under armclang,
4947 # but in baremetal builds (as tested here), feature detection is
4948 # unavailable, and the user is notified via a #warning. So enabling
4949 # this feature would prevent us from building with -Werror on
4950 # armclang. Tracked in #7198.
4951 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4952 scripts/config.py set MBEDTLS_HAVE_ASM
4953
Yanray Wang3ae11992023-11-13 17:32:09 +08004954 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08004955
4956 # test AESCE baremetal build
4957 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08004958 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08004959 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08004960
Yanray Wangef1b04d2023-09-08 11:09:26 +08004961 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004962 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4963 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4964 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wangef1b04d2023-09-08 11:09:26 +08004965 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004966 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004967 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Ronald Cron709bbf02024-07-03 07:59:30 +02004968 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
4969 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08004970}
4971
Gilles Peskine592f5912019-10-07 18:49:32 +02004972component_test_ctr_drbg_aes_256_sha_256 () {
4973 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4974 scripts/config.py full
4975 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4976 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004977 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004978 make
4979
4980 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4981 make test
4982}
4983
4984component_test_ctr_drbg_aes_128_sha_512 () {
4985 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004986 scripts/config.py full
4987 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4988 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00004989 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004990 make
4991
4992 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
4993 make test
4994}
4995
4996component_test_ctr_drbg_aes_128_sha_256 () {
4997 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004998 scripts/config.py full
4999 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5000 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5001 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005002 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005003 make
5004
5005 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5006 make test
5007}
5008
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005009component_test_se_default () {
5010 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005011 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005012 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005013
5014 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5015 make test
5016}
5017
Steven Cooremand57203d2020-07-16 20:28:59 +02005018component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005019 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005020 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005021 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005022 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5023 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005024 loc_cflags="${loc_cflags} -I../tests/include -O2"
5025
Gilles Peskine21570cf2023-12-22 11:49:50 +01005026 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005027
Gilles Peskine1997f302023-07-26 18:45:20 +02005028 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005029 make test
5030}
5031
Gilles Peskine8f073122018-11-27 15:58:47 +01005032component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005033 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005034 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005035 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005036 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005037}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005038
Gilles Peskinecf740502019-07-03 20:43:05 +02005039component_test_cmake_shared () {
5040 msg "build/test: cmake shared" # ~ 2min
5041 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5042 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005043 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005044 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005045 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005046}
5047
Gilles Peskineec10bf12019-09-20 19:56:06 +02005048test_build_opt () {
5049 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005050 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005051 for opt in "$@"; do
5052 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005053 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005054 # We're confident enough in compilers to not run _all_ the tests,
5055 # but at least run the unit tests. In particular, runs with
5056 # optimizations use inline assembly whereas runs with -O0
5057 # skip inline assembly.
5058 make test # ~30s
5059 make clean
5060 done
5061}
5062
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005063# For FreeBSD we invoke the function by name so this condition is added
5064# to disable the existing test_clang_opt function for linux.
5065if [[ $(uname) != "Linux" ]]; then
5066 component_test_clang_opt () {
5067 scripts/config.py full
5068 test_build_opt 'full config' clang -O0 -Os -O2
5069 }
5070fi
5071
5072component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005073 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005074 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005075}
5076support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005077 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005078}
5079
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005080component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005081 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005082 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005083}
5084support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005085 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005086}
5087
5088component_test_gcc_latest_opt () {
5089 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005090 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005091}
5092support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005093 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005094}
5095
5096component_test_gcc_earliest_opt () {
5097 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005098 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005099}
5100support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005101 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005102}
5103
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005104component_build_mbedtls_config_file () {
5105 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005106 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005107 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005108 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005109 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005110 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5111 make clean
5112
5113 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5114 # In the user config, disable one feature (for simplicity, pick a feature
5115 # that nothing else depends on).
5116 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005117 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005118 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5119
5120 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005121}
5122
Gilles Peskine7d904e72022-04-07 21:59:14 +02005123component_build_psa_config_file () {
5124 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5125 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5126 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5127 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5128 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005129 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005130 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5131 make clean
5132
5133 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005134 # In the user config, disable one feature and its dependencies, which will
5135 # reflect on the mbedtls configuration so we can query it with
5136 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005137 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005138 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005139 scripts/config.py unset MBEDTLS_CMAC_C
5140 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5141 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5142
5143 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005144}
5145
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005146component_build_psa_alt_headers () {
5147 msg "build: make with PSA alt headers" # ~20s
5148
5149 # Generate alternative versions of the substitutable headers with the
5150 # same content except different include guards.
5151 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5152
5153 # Build the library and some programs.
5154 # Don't build the fuzzers to avoid having to go through hoops to set
5155 # a correct include path for programs/fuzz/Makefile.
5156 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
5157 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\"'"
5158
5159 # Check that we're getting the alternative include guards and not the
5160 # original include guards.
5161 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5162 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5163 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5164 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5165}
5166
Dave Rodgman852de3c2023-12-14 14:46:45 +00005167component_test_m32_no_asm () {
5168 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005169 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005170 #
5171 # Note that we require gcc, because clang Asan builds fail to link for
5172 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005173 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005174 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005175 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005176 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005177 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005178
Dave Rodgman852de3c2023-12-14 14:46:45 +00005179 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005180 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005181}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005182support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005183 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005184 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005185 *) false;;
5186 esac
5187}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005188
Gilles Peskineff0aee02021-10-05 09:36:03 +02005189component_test_m32_o2 () {
5190 # Build with optimization, to use the i386 specific inline assembly
5191 # and go faster for tests.
5192 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005193 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005194 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005195 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005196
Gilles Peskineff0aee02021-10-05 09:36:03 +02005197 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005198 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005199
Gilles Peskineff0aee02021-10-05 09:36:03 +02005200 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005201 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005202}
Gilles Peskinecf522222021-10-07 19:25:29 +02005203support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005204 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005205}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005206
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005207component_test_m32_everest () {
5208 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005209 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005210 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005211 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005212
5213 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5214 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005215
5216 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005217 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005218
5219 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5220 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005221 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005222}
5223support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005224 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005225}
5226
Gilles Peskine8f073122018-11-27 15:58:47 +01005227component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005228 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005229 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005230 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005231
5232 msg "test: 64-bit ILP32, make, gcc"
5233 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005234}
Gilles Peskine878cf602019-01-06 20:50:38 +00005235support_test_mx32 () {
5236 case $(uname -m) in
5237 amd64|x86_64) true;;
5238 *) false;;
5239 esac
5240}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005241
Peter Kolbus60c6da22018-12-27 06:59:04 -06005242component_test_min_mpi_window_size () {
5243 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005244 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005245 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005246 make
5247
5248 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5249 make test
5250}
5251
Gilles Peskine8f073122018-11-27 15:58:47 +01005252component_test_have_int32 () {
5253 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005254 scripts/config.py unset MBEDTLS_HAVE_ASM
5255 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005256 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005257 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005258
Gilles Peskine8f073122018-11-27 15:58:47 +01005259 msg "test: gcc, force 32-bit bignum limbs"
5260 make test
5261}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005262
Gilles Peskine8f073122018-11-27 15:58:47 +01005263component_test_have_int64 () {
5264 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005265 scripts/config.py unset MBEDTLS_HAVE_ASM
5266 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005267 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005268 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005269
Gilles Peskine8f073122018-11-27 15:58:47 +01005270 msg "test: gcc, force 64-bit bignum limbs"
5271 make test
5272}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005273
Gabor Mezeie256cc12023-07-26 17:28:48 +02005274component_test_have_int32_cmake_new_bignum () {
5275 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5276 scripts/config.py unset MBEDTLS_HAVE_ASM
5277 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005278 scripts/config.py unset MBEDTLS_AESCE_C
5279 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005280 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005281 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005282
5283 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5284 make test
5285}
5286
Gilles Peskine8f073122018-11-27 15:58:47 +01005287component_test_no_udbl_division () {
5288 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005289 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005290 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005291 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005292
Gilles Peskine8f073122018-11-27 15:58:47 +01005293 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5294 make test
5295}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005296
Gilles Peskine8f073122018-11-27 15:58:47 +01005297component_test_no_64bit_multiplication () {
5298 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005299 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005300 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005301 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005302
Gilles Peskine8f073122018-11-27 15:58:47 +01005303 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5304 make test
5305}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005306
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005307component_test_no_strings () {
5308 msg "build: no strings" # ~10s
5309 scripts/config.py full
5310 # Disable options that activate a large amount of string constants.
5311 scripts/config.py unset MBEDTLS_DEBUG_C
5312 scripts/config.py unset MBEDTLS_ERROR_C
5313 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5314 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005315 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005316
5317 msg "test: no strings" # ~ 10s
5318 make test
5319}
5320
Hanno Beckerc5722d12020-10-09 11:10:42 +01005321component_test_no_x509_info () {
5322 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5323 scripts/config.pl full
5324 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5325 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005326 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005327
5328 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5329 make test
5330
5331 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005332 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005333}
5334
Gilles Peskine8f073122018-11-27 15:58:47 +01005335component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005336 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005337 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005338 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 +02005339
Gilles Peskinee36fe812021-09-01 20:00:33 +02005340 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005341 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005342 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005343 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005344}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005345
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005346component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005347 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005348 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005349 # Build for a target platform that's close to what Debian uses
5350 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005351 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005352 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005353 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005354 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'
5355
Gilles Peskinee36fe812021-09-01 20:00:33 +02005356 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005357 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005358 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005359 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005360}
5361support_build_arm_linux_gnueabi_gcc_arm5vte () {
5362 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5363}
5364
5365component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005366 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005367 scripts/config.py baremetal
5368 # This is an imperfect substitute for
5369 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005370 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005371 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 +02005372
Gilles Peskinee36fe812021-09-01 20:00:33 +02005373 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005374 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005375 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005376 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005377}
5378
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005379component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005380 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5381 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005382 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 +02005383
Gilles Peskinee36fe812021-09-01 20:00:33 +02005384 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005385 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005386 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005387 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005388 for lib in library/*.a; do
5389 echo "$lib:"
5390 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5391 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005392}
5393
Gilles Peskine8f073122018-11-27 15:58:47 +01005394component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005395 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005396 scripts/config.py baremetal
5397 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005398 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 +01005399 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005400 not grep __aeabi_uldiv library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005401 not grep __aeabi_uldiv ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005402 not grep __aeabi_uldiv ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005403}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005404
Gilles Peskine8f073122018-11-27 15:58:47 +01005405component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005406 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005407 scripts/config.py baremetal
5408 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005409 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 +01005410 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005411 not grep __aeabi_lmul library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005412 not grep __aeabi_lmul ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005413 not grep __aeabi_lmul ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005414}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005415
Dave Rodgman8c315f22023-06-02 10:26:24 -04005416component_build_arm_clang_thumb () {
5417 # ~ 30s
5418
5419 scripts/config.py baremetal
5420
5421 msg "build: clang thumb 2, make"
5422 make clean
5423 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5424
5425 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5426 msg "build: clang thumb 1 -O0, make"
5427 make clean
5428 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5429
5430 msg "build: clang thumb 1 -Os, make"
5431 make clean
5432 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5433}
5434
Gilles Peskine8f073122018-11-27 15:58:47 +01005435component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005436 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005437 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005438 # armc[56] don't support SHA-512 intrinsics
5439 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005440
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005441 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5442 scripts/config.py unset MBEDTLS_AESCE_C
5443
Dave Rodgman0fddf822023-03-02 15:32:12 +00005444 # Stop armclang warning about feature detection for A64_CRYPTO.
5445 # With this enabled, the library does build correctly under armclang,
5446 # but in baremetal builds (as tested here), feature detection is
5447 # unavailable, and the user is notified via a #warning. So enabling
5448 # this feature would prevent us from building with -Werror on
5449 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005450 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005451
Hanno Beckerf0762e92022-07-15 12:08:19 +01005452 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005453
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005454 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005455
5456 msg "size: ARM Compiler 5"
5457 "$ARMC5_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005458 "$ARMC5_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005459 "$ARMC5_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine18487f62020-04-30 23:11:54 +02005460
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005461 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005462
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005463 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005464 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005465
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005466 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005467 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5468
5469 # ARM Compiler 6 - Target ARMv7-M+DSP
5470 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005471
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005472 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005473 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005474
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005475 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005476 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005477
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005478 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5479 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5480
Dave Rodgman99318e62023-05-24 12:27:42 +01005481 # ARM Compiler 6 - Target Cortex-M0
5482 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005483
5484 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5485 #
5486 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5487 # that we have in our CI
5488 scripts/config.py set MBEDTLS_AESCE_C
5489 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005490}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005491
Pengyu Lvdf070032023-02-24 16:03:31 +08005492support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005493 armc5_cc="$ARMC5_BIN_DIR/armcc"
5494 armc6_cc="$ARMC6_BIN_DIR/armclang"
5495 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005496}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005497
Ronald Crond2cb7f42024-03-18 12:49:18 +01005498component_test_tls12_only () {
5499 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5500 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5501 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5502 make
5503
5504 msg "test: main suites (inc. selftests) (ASan build)"
5505 make test
5506
5507 msg "test: ssl-opt.sh (ASan build)"
5508 tests/ssl-opt.sh
5509
5510 msg "test: compat.sh (ASan build)"
5511 tests/compat.sh
5512}
5513
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005514component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005515 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005516 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005517 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005518 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5519
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005520 msg "test: TLS 1.3 only, all key exchange modes enabled"
5521 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005522
Ronald Cronc3f43b62022-10-17 17:35:32 +02005523 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5524 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005525}
5526
Ronald Cronc3f43b62022-10-17 17:35:32 +02005527component_test_tls13_only_psk () {
5528 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5529 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5530 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5531 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005532 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005533 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5534 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5535 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5536 scripts/config.py unset MBEDTLS_ECDSA_C
5537 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005538 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005539 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005540 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5541
Ronald Cronc3f43b62022-10-17 17:35:32 +02005542 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5543 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005544
Ronald Cronc3f43b62022-10-17 17:35:32 +02005545 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5546 tests/ssl-opt.sh
5547}
5548
5549component_test_tls13_only_ephemeral () {
5550 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5551 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5552 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005553 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005554 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5555
5556 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5557 cd tests; ./test_suite_ssl; cd ..
5558
5559 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5560 tests/ssl-opt.sh
5561}
5562
Przemek Stekiela01c2422023-06-13 10:46:48 +02005563component_test_tls13_only_ephemeral_ffdh () {
5564 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5565 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5566 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5567 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005568 scripts/config.py unset MBEDTLS_ECDH_C
5569
Przemek Stekiela01c2422023-06-13 10:46:48 +02005570 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5571
5572 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5573 cd tests; ./test_suite_ssl; cd ..
5574
5575 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5576 tests/ssl-opt.sh
5577}
5578
Ronald Cronc3f43b62022-10-17 17:35:32 +02005579component_test_tls13_only_psk_ephemeral () {
5580 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5581 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5582 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5583 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5584 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5585 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5586 scripts/config.py unset MBEDTLS_ECDSA_C
5587 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005588 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005589 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005590 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5591
5592 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5593 cd tests; ./test_suite_ssl; cd ..
5594
5595 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5596 tests/ssl-opt.sh
5597}
5598
Przemek Stekiela01c2422023-06-13 10:46:48 +02005599component_test_tls13_only_psk_ephemeral_ffdh () {
5600 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5601 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5602 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5603 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5604 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5605 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5606 scripts/config.py unset MBEDTLS_ECDSA_C
5607 scripts/config.py unset MBEDTLS_PKCS1_V21
5608 scripts/config.py unset MBEDTLS_PKCS7_C
5609 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005610 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005611 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5612
5613 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5614 cd tests; ./test_suite_ssl; cd ..
5615
5616 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5617 tests/ssl-opt.sh
5618}
5619
Ronald Cronc3f43b62022-10-17 17:35:32 +02005620component_test_tls13_only_psk_all () {
5621 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5622 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5623 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5624 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5625 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5626 scripts/config.py unset MBEDTLS_ECDSA_C
5627 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005628 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005629 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005630 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5631
5632 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5633 cd tests; ./test_suite_ssl; cd ..
5634
5635 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5636 tests/ssl-opt.sh
5637}
5638
5639component_test_tls13_only_ephemeral_all () {
5640 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5641 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005642 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005643 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5644
5645 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5646 cd tests; ./test_suite_ssl; cd ..
5647
5648 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5649 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005650}
5651
Ronald Cron46ac0652024-03-18 12:39:04 +01005652component_test_tls13_no_padding () {
5653 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005654 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005655 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005656 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005657 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005658 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005659 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005660 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005661 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005662}
5663
Ronald Cron6f135e12021-12-08 16:57:54 +01005664component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005665 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005666 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005667 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005668 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005669 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005670 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005671 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005672 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005673 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005674}
5675
Ronald Crondd96c0a2024-04-02 12:34:24 +02005676component_test_full_minus_session_tickets() {
5677 msg "build: full config without session tickets"
5678 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005679 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005680 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005681 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5682 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005683 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005684 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005685 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005686 tests/ssl-opt.sh
5687}
5688
Gilles Peskine8f073122018-11-27 15:58:47 +01005689component_build_mingw () {
5690 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005691 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 +00005692
Gilles Peskine8f073122018-11-27 15:58:47 +01005693 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005694 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 +01005695 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005696
Gilles Peskine8f073122018-11-27 15:58:47 +01005697 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005698 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
5699 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 +01005700 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005701
Pengyu Lv158eead2023-10-19 11:27:05 +08005702 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005703 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005704 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 +01005705 make WINDOWS_BUILD=1 clean
5706}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005707support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005708 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5709 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005710 *) true;;
5711 esac
5712}
Simon Butcher91aef332016-11-17 09:20:50 +00005713
Gilles Peskine8f073122018-11-27 15:58:47 +01005714component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005715 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005716 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005717 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5718 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005719
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005720 msg "test: main suites (MSan)" # ~ 10s
5721 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005722
Gilles Peskine6848d172023-11-02 19:58:03 +01005723 msg "test: metatests (MSan)"
5724 tests/scripts/run-metatests.sh any msan
5725
Gilles Peskine82b27272019-06-14 18:27:03 +02005726 msg "program demos (MSan)" # ~20s
5727 tests/scripts/run_demos.py
5728
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005729 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005730 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005731
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005732 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005733
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005734 if [ "$MEMORY" -gt 0 ]; then
5735 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005736 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005737 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005738}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005739
Bence Szépkúti0354d042023-12-06 16:14:37 +01005740component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005741 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005742 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005743 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5744 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005745
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005746 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005747 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005748
Gilles Peskine636c26a2020-03-04 20:46:15 +01005749 # Optional parts (slow; currently broken on OS X because programs don't
5750 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005751 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005752 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005753 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005754 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005755 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005756
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005757 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005758 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005759 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005760 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005761
5762 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005763 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005764 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005765 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005766}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005767
Bence Szépkúti0354d042023-12-06 16:14:37 +01005768component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005769 msg "build: Release, full (clang)"
5770 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5771 scripts/config.py full
5772 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5773 make
5774
5775 msg "test: main suites, Valgrind (full config)"
5776 make memcheck
5777}
5778
Paul Elliott62dc3922021-11-25 17:29:40 +00005779support_test_cmake_out_of_source () {
5780 distrib_id=""
5781 distrib_ver=""
5782 distrib_ver_minor=""
5783 distrib_ver_major=""
5784
5785 # Attempt to parse lsb-release to find out distribution and version. If not
5786 # found this should fail safe (test is supported).
5787 if [[ -f /etc/lsb-release ]]; then
5788
5789 while read -r lsb_line; do
5790 case "$lsb_line" in
5791 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5792 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5793 esac
5794 done < /etc/lsb-release
5795
5796 distrib_ver_major="${distrib_ver%%.*}"
5797 distrib_ver="${distrib_ver#*.}"
5798 distrib_ver_minor="${distrib_ver%%.*}"
5799 fi
5800
5801 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5802 # processor (as the CI does) can create a race condition whereby the build
5803 # fails to see a generated file, despite that file actually having been
5804 # generated. This problem appears to go away with 18.04 or newer, so make
5805 # the out of source tests unsupported on Ubuntu 16.04.
5806 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5807}
5808
Gilles Peskine8f073122018-11-27 15:58:47 +01005809component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005810 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005811 # generates
5812 make neat
5813
Gilles Peskine8f073122018-11-27 15:58:47 +01005814 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005815 MBEDTLS_ROOT_DIR="$PWD"
5816 mkdir "$OUT_OF_SOURCE_DIR"
5817 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005818 # Note: Explicitly generate files as these are turned off in releases
5819 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005820 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005821
Gilles Peskine8f073122018-11-27 15:58:47 +01005822 msg "test: cmake 'out-of-source' build"
5823 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005824 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005825 # Also ensure that there are no error messages such as
5826 # "No such file or directory", which would indicate that some required
5827 # file is missing (ssl-opt.sh tolerates the absence of some files so
5828 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005829 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005830 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005831 cat ssl-opt.err >&2
5832 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005833 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005834 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005835 cd "$MBEDTLS_ROOT_DIR"
5836 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005837}
Andres AGdc192212016-08-31 17:33:13 +01005838
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005839component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005840 # Remove existing generated files so that we use the ones CMake
5841 # generates
5842 make neat
5843
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005844 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005845 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005846 # Note: Explicitly generate files as these are turned off in releases
5847 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005848 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005849 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005850}
Gilles Peskinea3000992022-02-04 00:21:12 +01005851support_test_cmake_as_subdirectory () {
5852 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005853}
5854
Chris Kayd259e342021-03-25 16:03:25 +00005855component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005856 # Remove existing generated files so that we use the ones CMake
5857 # generates
5858 make neat
5859
Chris Kayd259e342021-03-25 16:03:25 +00005860 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005861 cd programs/test/cmake_package
5862 cmake .
5863 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005864 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005865}
Gilles Peskinea3000992022-02-04 00:21:12 +01005866support_test_cmake_as_package () {
5867 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005868}
5869
5870component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005871 # Remove existing generated files so that we use the ones CMake
5872 # generates
5873 make neat
5874
Chris Kayd259e342021-03-25 16:03:25 +00005875 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005876 cd programs/test/cmake_package_install
5877 cmake .
5878 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005879 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005880}
Gilles Peskinea3000992022-02-04 00:21:12 +01005881support_test_cmake_as_package_install () {
5882 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005883}
5884
David Horstmann20550e32023-01-12 14:17:01 +00005885component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005886 # Make a copy of config file to use for the in-tree test
5887 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005888
5889 MBEDTLS_ROOT_DIR="$PWD"
5890 mkdir "$OUT_OF_SOURCE_DIR"
5891 cd "$OUT_OF_SOURCE_DIR"
5892
David Horstmann969c1452023-01-31 10:34:44 +00005893 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005894 cmake "$MBEDTLS_ROOT_DIR"
5895 make
5896
5897 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5898 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005899 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005900 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5901 make
5902
5903 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5904 # In the user config, disable one feature (for simplicity, pick a feature
5905 # that nothing else depends on).
5906 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5907
5908 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5909 make
5910 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5911
5912 rm -f user_config.h full_config.h
5913
5914 cd "$MBEDTLS_ROOT_DIR"
5915 rm -rf "$OUT_OF_SOURCE_DIR"
5916
5917 # Now repeat the test for an in-tree build:
5918
David Horstmann969c1452023-01-31 10:34:44 +00005919 # Restore config for the in-tree test
5920 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005921
David Horstmann969c1452023-01-31 10:34:44 +00005922 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005923 cmake .
5924 make
5925
5926 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5927 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005928 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005929 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5930 make
5931
5932 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5933 # In the user config, disable one feature (for simplicity, pick a feature
5934 # that nothing else depends on).
5935 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5936
5937 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5938 make
5939 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5940
5941 rm -f user_config.h full_config.h
5942}
5943support_build_cmake_custom_config_file () {
5944 support_test_cmake_out_of_source
5945}
5946
David Horstmann041ed422024-05-10 14:37:48 +01005947component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01005948 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01005949 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
5950 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
5951 make
5952}
5953support_build_cmake_programs_no_testing () {
5954 support_test_cmake_out_of_source
5955}
David Horstmann20550e32023-01-12 14:17:01 +00005956
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005957component_build_zeroize_checks () {
5958 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5959
5960 scripts/config.py full
5961
5962 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00005963 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 +01005964}
5965
5966
Gilles Peskine8f073122018-11-27 15:58:47 +01005967component_test_zeroize () {
5968 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5969 # different combinations of compilers and optimization flags by using an
5970 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5971 # system in all cases that the script fails, so we must manually search the
5972 # output to check whether the pass string is present and no failure strings
5973 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005974
Gilles Peskine4976e822019-01-06 19:52:22 +00005975 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5976 # about a spurious message if Gdb tries and fails, so suppress that.
5977 gdb_disable_aslr=
5978 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
5979 gdb_disable_aslr='set disable-randomization off'
5980 fi
5981
Gilles Peskine8f073122018-11-27 15:58:47 +01005982 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01005983 for compiler in clang gcc; do
5984 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
5985 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005986 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
5987 grep "The buffer was correctly zeroized" test_zeroize.log
5988 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01005989 rm -f test_zeroize.log
5990 make clean
5991 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01005992 done
Gilles Peskine8f073122018-11-27 15:58:47 +01005993}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005994
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005995component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00005996 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005997 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00005998 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005999
6000 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006001 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006002}
6003
6004support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006005 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006006 ver="$(cmake --version)"
6007 ver="${ver#cmake version }"
6008 ver_major="${ver%%.*}"
6009
6010 ver="${ver#*.}"
6011 ver_minor="${ver%%.*}"
6012
6013 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006014}
6015
Gilles Peskinec848d222022-12-09 12:23:35 +01006016component_check_code_style () {
6017 msg "Check C code style"
6018 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006019}
6020
Gilles Peskinec848d222022-12-09 12:23:35 +01006021support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006022 case $(uncrustify --version) in
6023 *0.75.1*) true;;
6024 *) false;;
6025 esac
6026}
6027
Gilles Peskine8f073122018-11-27 15:58:47 +01006028component_check_python_files () {
6029 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006030 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006031}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006032
Joe Subbianid614c0b2021-07-29 11:18:29 +01006033component_check_test_helpers () {
6034 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006035 # unittest writes out mundane stuff like number or tests run on stderr.
6036 # Our convention is to reserve stderr for actual errors, and write
6037 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006038 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006039
Joe Subbiania25ffab2021-08-06 09:41:27 +01006040 msg "unit test: translate_ciphers.py"
6041 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006042}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006043
Valerio Settid9e42512024-05-06 15:59:51 +02006044component_test_psasim() {
Valerio Setti9022f712024-06-27 07:59:39 +02006045 msg "build server library and application"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006046 scripts/config.py crypto
Valerio Settid8b59372024-07-02 12:02:25 +02006047 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006048 helper_psasim_build server
Valerio Settid1b6ef12024-05-07 16:00:21 +02006049
Valerio Settid8b59372024-07-02 12:02:25 +02006050 helper_psasim_cleanup_before_client
Valerio Settif98635c2024-06-10 20:13:13 +02006051
6052 msg "build library for client"
Valerio Settid8b59372024-07-02 12:02:25 +02006053 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006054 helper_psasim_build client
Valerio Settif98635c2024-06-10 20:13:13 +02006055
Valerio Setti5beb2362024-06-24 13:13:17 +02006056 msg "build basic psasim client"
6057 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_base
6058 msg "test basic psasim client"
6059 tests/psa-client-server/psasim/test/run_test.sh psa_client_base
Valerio Settid9e42512024-05-06 15:59:51 +02006060
Valerio Setti5beb2362024-06-24 13:13:17 +02006061 msg "build full psasim client"
6062 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_full
6063 msg "test full psasim client"
6064 tests/psa-client-server/psasim/test/run_test.sh psa_client_full
Valerio Settid9e42512024-05-06 15:59:51 +02006065
Valerio Settid9e42512024-05-06 15:59:51 +02006066 make -C tests/psa-client-server/psasim clean
6067}
Jerry Yud767cc42023-03-31 15:03:55 +08006068
Valerio Setti9022f712024-06-27 07:59:39 +02006069component_test_suite_with_psasim()
6070{
6071 msg "build server library and application"
Valerio Settid8b59372024-07-02 12:02:25 +02006072 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006073 # Modify server's library configuration here (if needed)
6074 helper_psasim_build server
6075
Valerio Settid8b59372024-07-02 12:02:25 +02006076 helper_psasim_cleanup_before_client
Valerio Setti9022f712024-06-27 07:59:39 +02006077
6078 msg "build client library"
Valerio Settid8b59372024-07-02 12:02:25 +02006079 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006080 # PAKE functions are still unsupported from PSASIM
6081 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
6082 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
6083 helper_psasim_build client
6084
6085 msg "build test suites"
6086 make PSASIM=1 CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" tests
6087
6088 helper_psasim_server start
6089
Valerio Setti1a493832024-07-01 07:29:02 +02006090 # psasim takes an extremely long execution time on some test suites so we
6091 # exclude them from the list.
6092 SKIP_TEST_SUITES="constant_time_hmac,lmots,lms"
6093 export SKIP_TEST_SUITES
6094
Valerio Setti9022f712024-06-27 07:59:39 +02006095 msg "run test suites"
6096 make PSASIM=1 test
6097
6098 helper_psasim_server kill
6099}
6100
Gilles Peskine192c72f2017-12-21 15:59:21 +01006101################################################################
6102#### Termination
6103################################################################
6104
Gilles Peskine8f073122018-11-27 15:58:47 +01006105post_report () {
6106 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006107 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006108
Gilles Peskine8f073122018-11-27 15:58:47 +01006109 final_report
6110}
6111
6112
6113
6114################################################################
6115#### Run all the things
6116################################################################
6117
Gilles Peskine5d996822020-03-28 21:09:21 +01006118# Function invoked by --error-test to test error reporting.
6119pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006120 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006121 if [ $KEEP_GOING -ne 0 ]; then
6122 echo "Expect three failing commands."
6123 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006124 # If the component doesn't run in a subshell, changing error_test_i to an
6125 # invalid integer will cause an error in the loop that runs this function.
6126 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006127 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006128 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006129 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006130 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006131 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006132 make unknown_target
6133 false "this should not be executed"
6134}
6135
Gilles Peskinee48351a2018-11-27 16:06:30 +01006136# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006137run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006138 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006139 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006140
6141 # Unconditionally create a seedfile that's sufficiently long.
6142 # Do this before each component, because a previous component may
6143 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006144 local dd_cmd
6145 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6146 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006147 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006148 esac
6149 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006150
Gilles Peskineec135542021-08-02 23:14:03 +02006151 # Run the component in a subshell, with error trapping and output
6152 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006153 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006154 # We want to keep running if the subshell fails, so 'set -e' must
6155 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006156 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006157 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006158 (
6159 if [ $QUIET -eq 1 ]; then
6160 # msg() will be silenced, so just print the component name here.
6161 echo "${current_component#component_}"
6162 exec >/dev/null
6163 fi
6164 if [ $KEEP_GOING -eq 1 ]; then
6165 # Keep "set -e" off, and run an ERR trap instead to record failures.
6166 set -E
6167 trap err_trap ERR
6168 fi
6169 # The next line is what runs the component
6170 "$@"
6171 if [ $KEEP_GOING -eq 1 ]; then
6172 trap - ERR
6173 exit $last_failure_status
6174 fi
6175 )
6176 component_status=$?
6177 if [ $KEEP_GOING -eq 1 ]; then
6178 set -e
6179 if [ $component_status -ne 0 ]; then
6180 failure_count=$((failure_count + 1))
6181 fi
6182 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006183
6184 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006185 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006186 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006187}
6188
6189# Preliminary setup
6190pre_check_environment
6191pre_initialize_variables
6192pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006193
Dave Rodgman21900632024-02-26 11:41:19 +00006194setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006195pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006196pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006197pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006198
Gilles Peskine878cf602019-01-06 20:50:38 +00006199build_status=0
6200if [ $KEEP_GOING -eq 1 ]; then
6201 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006202fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006203pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006204pre_print_configuration
6205pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006206cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006207if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006208 pre_generate_files
6209fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006210
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006211# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006212for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006213 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006214done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006215unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006216for component in $RUN_COMPONENTS; do
6217 run_component "component_$component"
6218done
Gilles Peskine8f073122018-11-27 15:58:47 +01006219
6220# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006221post_report