blob: 7c89a51f03049f17a0df9e49cb133d43a25f7e76 [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 Cron635a2be2024-07-12 14:30:16 +0200346 rm -f tf-psa-crypto/tests/Makefile
Ronald Cronf37ff7f2024-07-02 07:36:39 +0200347 rm -f tf-psa-crypto/drivers/everest/Makefile
348 rm -f tf-psa-crypto/drivers/p256-m/Makefile
Ronald Cron82803982024-07-02 08:40:24 +0200349 rm -f tf-psa-crypto/drivers/builtin/Makefile
350 rm -f tf-psa-crypto/drivers/builtin/src/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200351
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100352 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
353 rm -rf programs/test/cmake_subproject/build
354 rm -f programs/test/cmake_subproject/Makefile
355 rm -f programs/test/cmake_subproject/cmake_subproject
356
Chris Kayd259e342021-03-25 16:03:25 +0000357 # Remove any artifacts from the component_test_cmake_as_package test.
358 rm -rf programs/test/cmake_package/build
359 rm -f programs/test/cmake_package/Makefile
360 rm -f programs/test/cmake_package/cmake_package
361
362 # Remove any artifacts from the component_test_cmake_as_installed_package test.
363 rm -rf programs/test/cmake_package_install/build
364 rm -f programs/test/cmake_package_install/Makefile
365 rm -f programs/test/cmake_package_install/cmake_package_install
366
Gilles Peskinef83eb822020-03-30 20:11:39 +0200367 # Restore files that may have been clobbered by the job
368 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200369 if [[ -e "$x$backup_suffix" ]]; then
370 cp -p "$x$backup_suffix" "$x"
371 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200372 done
373}
John Durkopbd069d32020-10-31 22:14:03 -0700374
Valerio Setti9022f712024-06-27 07:59:39 +0200375# This is a helper function to be used in psasim builds. It is meant to clean
376# up the library's workspace after the server build and before the client
377# build. Built libraries (mbedcrypto, mbedx509 and mbedtls) are supposed to be
378# already copied to psasim folder at this point.
Valerio Settid8b59372024-07-02 12:02:25 +0200379helper_psasim_cleanup_before_client() {
Valerio Setti9022f712024-06-27 07:59:39 +0200380 # Clean up library files
381 make -C library clean
382 # Clean up intermediate files that were used to build the server
383 make -C $PSASIM_PATH clean_server_intermediate_files
384 # Restore files that were backup before building library files. This
385 # includes $CONFIG_H and $CRYPTO_CONFIG_H.
386 for x in $files_to_back_up; do
387 if [[ -e "$x$backup_suffix" ]]; then
388 cp -p "$x$backup_suffix" "$x"
389 fi
390 done
391}
392
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200393# Final cleanup when this script exits (except when exiting on a failure
394# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200395final_cleanup () {
396 cleanup
397
398 for x in $files_to_back_up; do
399 rm -f "$x$backup_suffix"
400 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100401}
402
Gilles Peskine7c652162017-12-11 00:01:40 +0100403# Executed on exit. May be redefined depending on command line options.
404final_report () {
405 :
406}
407
408fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200409 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100410 final_report $1
411 trap - $1
412 kill -$1 $$
413}
414
415trap 'fatal_signal HUP' HUP
416trap 'fatal_signal INT' INT
417trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200418
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200419# Number of processors on this machine. Used as the default setting
420# for parallel make.
421all_sh_nproc ()
422{
423 {
424 nproc || # Linux
425 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
426 sysctl -n hw.ncpu || # FreeBSD
427 echo 1
428 } 2>/dev/null
429}
430
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100431msg()
432{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100433 if [ -n "${current_component:-}" ]; then
434 current_section="${current_component#component_}: $1"
435 else
436 current_section="$1"
437 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200438
439 if [ $QUIET -eq 1 ]; then
440 return
441 fi
442
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100443 echo ""
444 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100445 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000446 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100447 echo "******************************************************************"
448}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100449
Gilles Peskine8f073122018-11-27 15:58:47 +0100450armc6_build_test()
451{
452 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100453
Gilles Peskine18487f62020-04-30 23:11:54 +0200454 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800455 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100456 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000457 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200458
459 msg "size: ARM Compiler 6 ($FLAGS)"
460 "$ARMC6_FROMELF" -z library/*.o
Ronald Cron90279552024-07-04 09:25:59 +0200461 if [ -n ${PSA_CORE_PATH} ]; then
462 "$ARMC6_FROMELF" -z ${PSA_CORE_PATH}/*.o
463 fi
464 if [ -n ${BUILTIN_SRC_PATH} ]; then
465 "$ARMC6_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
466 fi
Gilles Peskine8f073122018-11-27 15:58:47 +0100467}
Andres AGa5cd9732016-10-17 15:23:10 +0100468
Andres AGd9eba4b2016-08-26 14:42:14 +0100469err_msg()
470{
471 echo "$1" >&2
472}
473
474check_tools()
475{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200476 for tool in "$@"; do
477 if ! `type "$tool" >/dev/null 2>&1`; then
478 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100479 exit 1
480 fi
481 done
482}
483
Gilles Peskine8f073122018-11-27 15:58:47 +0100484pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000485 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100486 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100487 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100488 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200489 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000490 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100491
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000492 # Note that legacy options are ignored instead of being omitted from this
493 # list of options, so invocations that worked with previous version of
494 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100495 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100496 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200497 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200498 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200499 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000500 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100501 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
502 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100503 --clang-earliest) shift; CLANG_EARLIEST="$1";;
504 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100505 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000506 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100507 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100508 --gcc-earliest) shift; GCC_EARLIEST="$1";;
509 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100510 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200511 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
512 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100513 --gnutls-serv) shift; GNUTLS_SERV="$1";;
514 --help|-h) usage; exit;;
515 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000516 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100517 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100518 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200519 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000520 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100521 --no-force) FORCE=0;;
522 --no-keep-going) KEEP_GOING=0;;
523 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200524 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100525 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100526 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200527 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100528 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200529 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100530 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200531 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200532 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100533 --seed|-s) shift; SEED="$1";;
534 -*)
535 echo >&2 "Unknown option: $1"
536 echo >&2 "Run $0 --help for usage."
537 exit 120
538 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000539 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100540 esac
541 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100542 done
SimonB2e23c822016-04-16 21:54:39 +0100543
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100544 # Exclude components that are not supported on this platform.
545 SUPPORTED_COMPONENTS=
546 for component in $ALL_COMPONENTS; do
547 case $(type "support_$component" 2>&1) in
548 *' function'*)
549 if ! support_$component; then continue; fi;;
550 esac
551 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
552 done
553
554 if [ $list_components -eq 1 ]; then
555 printf '%s\n' $SUPPORTED_COMPONENTS
556 exit
557 fi
558
Gilles Peskinea28db922019-01-10 00:05:18 +0100559 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200560 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000561 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100562 fi
563
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000564 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
565 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100566 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000567 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100568 fi
SimonB2e23c822016-04-16 21:54:39 +0100569
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200570 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100571 if [ $all_except -eq 0 ]; then
572 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200573 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
574 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200575 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100576 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200577 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200578 # If the requested name includes a wildcard character, don't
579 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100580 case $component in
581 *[*?\[]*) continue;;
582 esac
583 case " $SUPPORTED_COMPONENTS " in
584 *" $component "*) :;;
585 *)
586 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
587 unsupported=$((unsupported + 1));;
588 esac
589 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200590 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100591 if [ $unsupported -ne 0 ]; then
592 exit 2
593 fi
594 fi
595
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000596 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100597 RUN_COMPONENTS=
598 for component in $SUPPORTED_COMPONENTS; do
599 if is_component_included "$component"; [ $? -eq $all_except ]; then
600 RUN_COMPONENTS="$RUN_COMPONENTS $component"
601 fi
602 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000603
604 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000605 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100606}
SimonB2e23c822016-04-16 21:54:39 +0100607
Gilles Peskine8f073122018-11-27 15:58:47 +0100608pre_check_git () {
609 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100610 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100611 git checkout-index -f -q $CONFIG_H
612 cleanup
613 else
SimonB2e23c822016-04-16 21:54:39 +0100614
Gilles Peskine8f073122018-11-27 15:58:47 +0100615 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
616 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
617 echo "You can either delete this directory manually, or force the test by rerunning"
618 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
619 exit 1
620 fi
621
Ronald Cron7a93ac52023-07-20 09:49:12 +0200622 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100623 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100624 echo "You can either delete or preserve your work, or force the test by rerunning the"
625 echo "script as: $0 --force"
626 exit 1
627 fi
SimonB2e23c822016-04-16 21:54:39 +0100628 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500629}
630
Gilles Peskine568f53a2021-07-12 18:16:01 +0200631pre_restore_files () {
632 # If the makefiles have been generated by a framework such as cmake,
633 # restore them from git. If the makefiles look like modifications from
634 # the ones checked into git, take care not to modify them. Whatever
635 # this function leaves behind is what the script will restore before
636 # each component.
637 case "$(head -n1 Makefile)" in
638 *[Gg]enerated*)
639 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
640 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
641 ;;
642 esac
643}
644
Gilles Peskinef83eb822020-03-30 20:11:39 +0200645pre_back_up () {
646 for x in $files_to_back_up; do
647 cp -p "$x" "$x$backup_suffix"
648 done
649}
650
Gilles Peskine8f073122018-11-27 15:58:47 +0100651pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100652 failure_count=0 # Number of failed components
653 last_failure_status=0 # Last failure status in this component
654
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100655 # See err_trap
656 previous_failure_status=0
657 previous_failed_command=
658 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100659 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100660
Gilles Peskine7c652162017-12-11 00:01:40 +0100661 start_red=
662 end_color=
663 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100664 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100665 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
666 start_red=$(printf '\033[31m')
667 end_color=$(printf '\033[0m')
668 ;;
669 esac
670 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100671
672 # Keep a summary of failures in a file. We'll print it out at the end.
673 failure_summary_file=$PWD/all-sh-failures-$$.log
674 : >"$failure_summary_file"
675
676 # Whether it makes sense to keep a component going after the specified
677 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200678 # This function normally receives the failing simple command
679 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
680 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200682 # False positives result in running things that can't be expected to
683 # work. False negatives result in things not running after something else
684 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100685 can_keep_going_after_failure () {
686 case "$1" in
687 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200688 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100689 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200690 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
691 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
692 *make*check*) true;;
693 "grep "*) true;;
694 "[ "*) true;;
695 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100696 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100697 esac
698 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100699
700 # This function runs if there is any error in a component.
701 # It must either exit with a nonzero status, or set
702 # last_failure_status to a nonzero value.
703 err_trap () {
704 # Save $? (status of the failing command). This must be the very
705 # first thing, before $? is overridden.
706 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100707 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100708
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100709 if [[ $last_failure_status -eq $previous_failure_status &&
710 "$failed_command" == "$previous_failed_command" &&
711 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
712 then
713 # The same command failed twice in a row, but this time one level
714 # less deep in the function call stack. This happens when the last
715 # command of a function returns a nonzero status, and the function
716 # returns that same status. Ignore the second failure.
717 previous_failure_funcall_depth=${#FUNCNAME[@]}
718 return
719 fi
720 previous_failure_status=$last_failure_status
721 previous_failed_command=$failed_command
722 previous_failure_funcall_depth=${#FUNCNAME[@]}
723
Gilles Peskinece266c42020-03-28 18:50:43 +0100724 text="$current_section: $failed_command -> $last_failure_status"
725 echo "${start_red}^^^^$text^^^^${end_color}" >&2
726 echo "$text" >>"$failure_summary_file"
727
728 # If the command is fatal (configure or build command), stop this
729 # component. Otherwise (test command) keep the component running
730 # (run more tests from the same build).
731 if ! can_keep_going_after_failure "$failed_command"; then
732 exit $last_failure_status
733 fi
734 }
735
Gilles Peskine7c652162017-12-11 00:01:40 +0100736 final_report () {
737 if [ $failure_count -gt 0 ]; then
738 echo
739 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100740 echo "${start_red}FAILED: $failure_count components${end_color}"
741 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100742 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
743 elif [ -z "${1-}" ]; then
744 echo "SUCCESS :)"
745 fi
746 if [ -n "${1-}" ]; then
747 echo "Killed by SIG$1."
748 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100749 rm -f "$failure_summary_file"
750 if [ $failure_count -gt 0 ]; then
751 exit 1
752 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100753 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100754}
755
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200756# record_status() and if_build_succeeded() are kept temporarily for backward
757# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100758record_status () {
759 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100760}
Gilles Peskine7c652162017-12-11 00:01:40 +0100761if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100762 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100763}
764
Gilles Peskinea681c592020-03-28 21:27:40 +0100765# '! true' does not trigger the ERR trap. Arrange to trigger it, with
766# a reasonably informative error message (not just "$@").
767not () {
768 if "$@"; then
769 report_failed_command="! $*"
770 false
771 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200772 fi
773}
774
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200775pre_prepare_outcome_file () {
776 case "$MBEDTLS_TEST_OUTCOME_FILE" in
777 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
778 esac
779 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
780 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
781 fi
782}
783
Gilles Peskine8f073122018-11-27 15:58:47 +0100784pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200785 if [ $QUIET -eq 1 ]; then
786 return
787 fi
788
Gilles Peskine8f073122018-11-27 15:58:47 +0100789 msg "info: $0 configuration"
790 echo "MEMORY: $MEMORY"
791 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200792 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100793 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100794 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100795 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100796 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
797 echo "GNUTLS_CLI: $GNUTLS_CLI"
798 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100799 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
800 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
801}
Andres AG7770ea82016-10-10 15:46:20 +0100802
Andres AGd9eba4b2016-08-26 14:42:14 +0100803# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100804pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000805 # Build the list of variables to pass to output_env.sh.
806 set env
SimonB2e23c822016-04-16 21:54:39 +0100807
Gilles Peskine87964262019-01-06 22:40:00 +0000808 case " $RUN_COMPONENTS " in
809 # Require OpenSSL and GnuTLS if running any tests (as opposed to
810 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
811 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100812 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000813 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
814 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100815 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000816 export GNUTLS_CLI="$GNUTLS_CLI"
817 export GNUTLS_SERV="$GNUTLS_SERV"
818 # Avoid passing --seed flag in every call to ssl-opt.sh
819 if [ -n "${SEED-}" ]; then
820 export SEED
821 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200822 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000823 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200824 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
825 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000826 ;;
827 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200828
Gilles Peskine87964262019-01-06 22:40:00 +0000829 case " $RUN_COMPONENTS " in
830 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
831 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100832
Gilles Peskine87964262019-01-06 22:40:00 +0000833 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200834 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000835 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100836
Gilles Peskine87964262019-01-06 22:40:00 +0000837 case " $RUN_COMPONENTS " in
838 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
839 esac
840
841 case " $RUN_COMPONENTS " in
842 *" test_zeroize "*) check_tools "gdb";;
843 esac
844
845 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000846 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000847 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
848 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200849 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000850 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
851 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200852 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
853 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
854 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000855 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000856
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200857 # past this point, no call to check_tool, only printing output
858 if [ $QUIET -eq 1 ]; then
859 return
860 fi
861
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000862 msg "info: output_env.sh"
863 case $RUN_COMPONENTS in
864 *_armcc*)
865 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
866 *) set "$@" RUN_ARMCC=0;;
867 esac
868 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100869}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100870
Gilles Peskine1570b592021-04-22 01:10:12 +0200871pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200872 # since make doesn't have proper dependencies, remove any possibly outdate
873 # file that might be around before generating fresh ones
874 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200875 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200876 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200877 else
878 make generated_files
879 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200880}
881
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000882clang_version() {
883 if command -v clang > /dev/null ; then
884 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
885 else
886 echo 0 # report version 0 for "no clang"
887 fi
888}
889
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200890################################################################
891#### Helpers for components using libtestdriver1
892################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100893
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200894# How to use libtestdriver1
895# -------------------------
896#
897# 1. Define the list algorithms and key types to accelerate,
898# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
899# Examples:
900# - loc_accel_list="ALG_JPAKE"
901# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200902# 2. Make configurations changes for the driver and/or main libraries.
903# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
904# can be either "default" to start with the default config, or a name
905# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200906# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200907# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
908# These changes affect both the driver and the main libraries.
909# (Note: they need to have the same set of PSA_WANT symbols, as that
910# determines the ABI between them.)
911# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
912# main libraries. Typically, you want to disable the module(s) that are
913# being accelerated. You may need to also disable modules that depend
914# on them or options that are not supported with drivers.
915# 2d. On top of psa/crypto_config.h, the driver library uses its own config
916# file: tests/include/test/drivers/config_test_driver.h. You usually
917# don't need to edit it: using loc_extra_list (see below) is preferred.
918# However, when there's no PSA symbol for what you want to enable,
919# calling scripts/config.py on this file remains the only option.
920# 3. Build the driver library, then the main libraries, test, and programs.
921# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
922# need to enable more algorithms here, typically hash algorithms when
923# accelerating some signature algorithms (ECDSA, RSAv2). This is done
924# by passing a 2nd argument listing the extra algorithms.
925# Example:
926# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
927# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800928# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200929# additional arguments will be passed to make: this can be useful if
930# you don't want to build everything when iterating during development.
931# Example:
932# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
933# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200934
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200935# Adjust the configuration - for both libtestdriver1 and main library,
936# as they should have the same PSA_WANT macros.
937helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200938 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200939 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200940 if [ "$base_config" != "default" ]; then
941 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200942 fi
943
944 # Enable PSA-based config (necessary to use drivers)
945 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
946
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200947 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
948 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
949 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000950
951 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
952 # otherwise we will end up running multithreaded tests without mutexes to protect them.
953 if scripts/config.py get MBEDTLS_THREADING_C; then
954 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
955 fi
956
957 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
958 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
959 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200960}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100961
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100962# Build the drivers library libtestdriver1.a (with ASan).
963#
964# Parameters:
965# 1. a space-separated list of things to accelerate;
966# 2. optional: a space-separate list of things to also support.
967# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
968helper_libtestdriver1_make_drivers() {
969 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
970 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
971}
972
973# Build the main libraries, programs and tests,
974# linking to the drivers library (with ASan).
975#
976# Parameters:
977# 1. a space-separated list of things to accelerate;
978# *. remaining arguments if any are passed directly to make
979# (examples: lib, -C tests test_suite_xxx, etc.)
980# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
981helper_libtestdriver1_make_main() {
982 loc_accel_list=$1
983 shift
984
985 # we need flags both with and without the LIBTESTDRIVER1_ prefix
986 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
987 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
988 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" "$@"
989}
990
Valerio Setti9022f712024-06-27 07:59:39 +0200991# Set some default values $CONFIG_H in order to build server or client sides
992# in PSASIM. There is only 1 mandatory parameter:
993# - $1: target which can be "client" or "server"
Valerio Settid8b59372024-07-02 12:02:25 +0200994helper_psasim_config() {
Valerio Settid1b6ef12024-05-07 16:00:21 +0200995 TARGET=$1
Valerio Settid1b6ef12024-05-07 16:00:21 +0200996
Valerio Settid1b6ef12024-05-07 16:00:21 +0200997 if [ "$TARGET" == "client" ]; then
998 scripts/config.py full
999 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1000 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1001 # Dynamic secure element support is a deprecated feature and it is not
1002 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1003 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1004 # Disable potentially problematic features
1005 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1006 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1007 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1008 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1009 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01001010 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +02001011 else
1012 scripts/config.py crypto_full
1013 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Tom Cosgrove0fe5b8d2024-06-11 17:26:17 +01001014 # We need to match the client with MBEDTLS_PSA_CRYPTO_SE_C
1015 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1016 # Also ensure MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER not set (to match client)
1017 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +02001018 fi
Valerio Setti9022f712024-06-27 07:59:39 +02001019}
Valerio Settid1b6ef12024-05-07 16:00:21 +02001020
Valerio Setti9022f712024-06-27 07:59:39 +02001021# Helper to build the libraries for client/server in PSASIM. If the server is
1022# being built, then it builds also the final executable.
1023# There is only 1 mandatory parameter:
1024# - $1: target which can be "client" or "server"
1025helper_psasim_build() {
1026 TARGET=$1
1027 shift
1028 TARGET_LIB=${TARGET}_libs
1029
1030 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
1031
1032 # Build also the server application after its libraries have been built.
1033 if [ "$TARGET" == "server" ]; then
1034 make -C $PSASIM_PATH CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_server
1035 fi
Valerio Settid1b6ef12024-05-07 16:00:21 +02001036}
1037
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +01001038################################################################
1039#### Configuration helpers
1040################################################################
1041
Valerio Settib2fd6732023-08-15 17:10:47 +02001042# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +02001043# The function optionally accepts 1 parameter: a space-separated list of the
1044# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +02001045helper_disable_builtin_curves() {
1046 allowed_list="${1:-}"
1047 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
1048
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001049 for curve in $allowed_list; do
1050 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001051 done
1052}
1053
1054# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1055# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1056# in the following helpers.
1057helper_get_psa_curve_list () {
1058 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001059 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1060 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001061 done
1062
1063 echo "$loc_list"
1064}
1065
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001066# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1067# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1068# in the following helpers.
1069helper_get_psa_dh_group_list () {
1070 loc_list=""
1071 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1072 loc_list="$loc_list $item"
1073 done
1074
1075 echo "$loc_list"
1076}
1077
Valerio Settib2fd6732023-08-15 17:10:47 +02001078# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001079# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001080# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001081helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001082 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001083 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001084 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 +02001085 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1086 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001087 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1088 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001089 fi
1090 done
1091
1092 echo "$loc_list"
1093}
1094
Valerio Setti9022f712024-06-27 07:59:39 +02001095# Helper function for controlling (start & stop) the psasim server.
1096helper_psasim_server() {
1097 OPERATION=$1
1098 if [ "$OPERATION" == "start" ]; then
1099 (
1100 cd tests
Ronald Cron7262b472024-07-22 08:56:10 +02001101 msg "start server in tests"
Valerio Setti9022f712024-06-27 07:59:39 +02001102 psa-client-server/psasim/test/start_server.sh
Ronald Cron7262b472024-07-22 08:56:10 +02001103 msg "start server in tf-psa-crypto/tests"
1104 cd ../tf-psa-crypto/tests
1105 ../../tests/psa-client-server/psasim/test/start_server.sh
Valerio Setti9022f712024-06-27 07:59:39 +02001106 )
1107 else
1108 (
Ronald Cron7262b472024-07-22 08:56:10 +02001109 msg "terminate servers and cleanup"
1110 tests/psa-client-server/psasim//test/kill_servers.sh
Ronald Crone0e26f72024-07-22 11:51:02 +02001111
1112 # Remove temporary files and logs
Ronald Cron7262b472024-07-22 08:56:10 +02001113 cd tests
1114 rm -f psa_notify_*
1115 rm -f psa_service_*
1116 rm -f psa_server.log
1117
1118 cd ../tf-psa-crypto/tests
Ronald Crone0e26f72024-07-22 11:51:02 +02001119 rm -f psa_notify_*
1120 rm -f psa_service_*
1121 rm -f psa_server.log
Valerio Setti9022f712024-06-27 07:59:39 +02001122 )
1123 fi
1124}
1125
Gilles Peskine192c72f2017-12-21 15:59:21 +01001126################################################################
1127#### Basic checks
1128################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001129
1130#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001131# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001132#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001133# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001134# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001135# 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 +02001136# time, so start with a GCC build).
1137# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001138#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001139# Indicative running times are given for reference.
1140
Gilles Peskine8f073122018-11-27 15:58:47 +01001141component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001142 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001143 tests/scripts/recursion.pl library/*.c
Ronald Cron5b41a652024-07-03 08:59:47 +02001144 tests/scripts/recursion.pl ${PSA_CORE_PATH}/*.c
Ronald Cron709bbf02024-07-03 07:59:30 +02001145 tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001146}
Janos Follathb72c6782016-07-19 14:54:17 +01001147
Gilles Peskine67debb62021-05-18 16:09:50 +02001148component_check_generated_files () {
1149 msg "Check: check-generated-files, files generated with make" # 2s
1150 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001151 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001152
1153 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001154 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001155 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001156 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001157
1158 msg "Check: check-generated-files -u, files absent" # 2s
1159 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001160 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001161 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001162 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001163
1164 # This component ends with the generated files present in the source tree.
1165 # This is necessary for subsequent components!
1166}
1167
Gilles Peskine8f073122018-11-27 15:58:47 +01001168component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001169 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001170 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001171}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001172
Gilles Peskine8f073122018-11-27 15:58:47 +01001173component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001174 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001175 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001176}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001177
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001178component_check_changelog () {
1179 msg "Check: changelog entries" # < 1s
1180 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001181 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001182 if [ -e ChangeLog.new ]; then
1183 # Show the diff for information. It isn't an error if the diff is
1184 # non-empty.
1185 diff -u ChangeLog ChangeLog.new || true
1186 rm ChangeLog.new
1187 fi
1188}
1189
Gilles Peskine8f073122018-11-27 15:58:47 +01001190component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001191 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001192 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001193}
Darryl Greena07039c2018-03-13 16:48:16 +00001194
Gilles Peskine895868b2019-09-19 21:30:05 +02001195component_check_test_cases () {
1196 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001197 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001198 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001199 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001200 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001201 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001202 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001203 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001204}
1205
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001206component_check_test_dependencies () {
1207 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001208 # The purpose of this component is to catch unjustified dependencies on
1209 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1210 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1211 # MBEDTLS_PSA_xxx).
1212 #
1213 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1214 # this component is meant to catch. However a few of them are justified,
1215 # mostly by the absence of a PSA equivalent, so this component includes a
1216 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001217
1218 found="check-test-deps-found-$$"
1219 expected="check-test-deps-expected-$$"
1220
1221 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001222 grep 'depends_on' \
Ronald Cron635a2be2024-07-12 14:30:16 +02001223 tf-psa-crypto/tests/suites/test_suite_psa*.data \
1224 tf-psa-crypto/tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001225 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001226 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001227 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001228
Yanray Wang18040ed2023-11-23 21:29:56 +08001229 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001230 rm -f $expected
1231 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1232 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001233 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1234 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001235 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1236 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001237 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1238 # the test code and that's probably the most convenient way of achieving
1239 # the test's goal.
1240 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1241 # No PSA equivalent - we should probably have one in the future.
1242 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1243 # No PSA equivalent - needed by some init tests
1244 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001245 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001246 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001247
1248 # Compare reality with expectation.
1249 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001250 #
1251 # The output should be empty. When it's not:
1252 # - Each '+' line is a macro that was found but not expected. You want to
1253 # find where that macro occurs, and either replace it with PSA macros, or
1254 # add it to the exceptions list above with a justification.
1255 # - Each '-' line is a macro that was expected but not found; it means the
1256 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001257 diff -U0 $expected $found
1258
1259 rm $found $expected
1260}
1261
Gilles Peskine8f073122018-11-27 15:58:47 +01001262component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001263 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001264 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001265}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001266
Gilles Peskine192c72f2017-12-21 15:59:21 +01001267
Gilles Peskine636c26a2020-03-04 20:46:15 +01001268
Gilles Peskine192c72f2017-12-21 15:59:21 +01001269################################################################
1270#### Build and test many configurations and targets
1271################################################################
1272
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001273component_test_default_out_of_box () {
1274 msg "build: make, default config (out-of-box)" # ~1min
1275 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001276 # Disable fancy stuff
1277 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001278
1279 msg "test: main suites make, default config (out-of-box)" # ~10s
1280 make test
1281
1282 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001283 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001284
1285 msg "program demos: make, default config (out-of-box)" # ~10s
1286 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001287}
1288
Gilles Peskine8f073122018-11-27 15:58:47 +01001289component_test_default_cmake_gcc_asan () {
1290 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001291 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1292 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001293
Gilles Peskine8f073122018-11-27 15:58:47 +01001294 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1295 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001296
Gilles Peskine82b27272019-06-14 18:27:03 +02001297 msg "program demos (ASan build)" # ~10s
1298 tests/scripts/run_demos.py
1299
Gilles Peskine97bea012020-04-23 23:37:45 +02001300 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001301 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001302
Gilles Peskine6848d172023-11-02 19:58:03 +01001303 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001304 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001305
Gilles Peskine8f073122018-11-27 15:58:47 +01001306 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001307 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001308
Gilles Peskine8f073122018-11-27 15:58:47 +01001309 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001310 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001311
1312 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001313 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001314}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001315
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001316component_test_default_cmake_gcc_asan_new_bignum () {
1317 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001318 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001319 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001320 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001321
1322 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1323 make test
1324
1325 msg "test: selftest (ASan build)" # ~ 10s
1326 programs/test/selftest
1327
1328 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1329 tests/ssl-opt.sh
1330
1331 msg "test: compat.sh (ASan build)" # ~ 6 min
1332 tests/compat.sh
1333
1334 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1335 tests/context-info.sh
1336}
1337
Hanno Becker01635512019-02-26 14:27:09 +00001338component_test_full_cmake_gcc_asan () {
1339 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001340 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001341 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1342 make
1343
1344 msg "test: main suites (inc. selftests) (full config, ASan build)"
1345 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001346
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001347 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001348 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001349
Gilles Peskine636c26a2020-03-04 20:46:15 +01001350 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001351 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001352
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001353 # Note: the next two invocations cover all compat.sh test cases.
1354 # We should use the same here and in basic-build-test.sh.
1355 msg "test: compat.sh: default version (full config, ASan build)"
1356 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001357
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001358 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1359 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001360
1361 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001362 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001363}
1364
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001365
1366component_test_full_cmake_gcc_asan_new_bignum () {
1367 msg "build: full config, cmake, gcc, ASan"
1368 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001369 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001370 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001371 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001372
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001373 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001374 make test
1375
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001376 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001377 programs/test/selftest
1378
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001379 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001380 tests/ssl-opt.sh
1381
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001382 # Note: the next two invocations cover all compat.sh test cases.
1383 # We should use the same here and in basic-build-test.sh.
1384 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1385 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001386
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001387 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1388 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001389
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001390 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001391 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001392}
1393
Ronald Cronc3623db2020-10-29 10:51:32 +01001394component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001395 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001396 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001397 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1398 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1399 make
1400
1401 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1402 make test
1403}
1404
David Horstmann4a48bec2024-03-13 15:42:31 +00001405component_test_psa_assume_exclusive_buffers () {
1406 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001407 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001408 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001409 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1410 make
1411
David Horstmann4a48bec2024-03-13 15:42:31 +00001412 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001413 make test
1414}
1415
Gilles Peskinea3548672021-06-17 11:37:52 +02001416# check_renamed_symbols HEADER LIB
1417# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1418# name is LIB.
1419check_renamed_symbols () {
1420 ! nm "$2" | sed 's/.* //' |
1421 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1422}
1423
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001424component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001425 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001426 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001427 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1428 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1429 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1430 # We can only compile, not link, since our test and sample programs
1431 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1432 # is active.
1433 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001434
1435 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1436 # version is not present.
1437 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001438 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001439}
1440
Ryan Everettdaa322a2024-04-18 16:48:55 +01001441component_test_no_rsa_key_pair_generation() {
1442 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001443 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001444 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001445 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001446 make
1447
Ryan Everettdaa322a2024-04-18 16:48:55 +01001448 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001449 make test
1450}
1451
Gilles Peskine782f4112018-11-27 16:11:09 +01001452component_test_ref_configs () {
1453 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001454 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1455 # want to re-generate generated files that depend on it, quite correctly.
1456 # However this doesn't work as the generation script expects a specific
1457 # format for mbedtls_config.h, which the other files don't follow. Also,
1458 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001459 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001460 # whether they're on or off. So, disable cmake's (over-sensitive here)
1461 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001462 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001463 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cron635a2be2024-07-12 14:30:16 +02001464 tests/scripts/test-ref-configs.pl config-tfm.h
Gilles Peskine782f4112018-11-27 16:11:09 +01001465}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001466
Gilles Peskine8f073122018-11-27 15:58:47 +01001467component_test_no_renegotiation () {
1468 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001469 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001470 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001471 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001472
Gilles Peskine8f073122018-11-27 15:58:47 +01001473 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1474 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001477 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001478}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001479
Gilles Peskine636c26a2020-03-04 20:46:15 +01001480component_test_no_pem_no_fs () {
1481 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1482 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1483 scripts/config.py unset MBEDTLS_FS_IO
1484 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1485 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001486 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001487 make
1488
1489 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1490 make test
1491
1492 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001493 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001494}
1495
Gilles Peskine8f073122018-11-27 15:58:47 +01001496component_test_rsa_no_crt () {
1497 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001498 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001499 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001500 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001501
Gilles Peskine8f073122018-11-27 15:58:47 +01001502 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1503 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001504
Gilles Peskine8f073122018-11-27 15:58:47 +01001505 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001506 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001507
Gilles Peskine8f073122018-11-27 15:58:47 +01001508 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001509 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001510
1511 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001512 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001513}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001514
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001515component_test_no_ctr_drbg_classic () {
1516 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001517 scripts/config.py full
1518 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001519 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001520 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001521
Dave Rodgman17127e92023-12-14 16:42:48 +00001522 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001523 make
1524
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001525 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001526 make test
1527
Gilles Peskineba749042021-01-13 20:02:03 +01001528 # In this configuration, the TLS test programs use HMAC_DRBG.
1529 # The SSL tests are slow, so run a small subset, just enough to get
1530 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001531 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001532 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001533
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001534 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001535 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001536}
1537
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001538component_test_no_ctr_drbg_use_psa () {
1539 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001540 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001541 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1542 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001543
Dave Rodgman17127e92023-12-14 16:42:48 +00001544 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001545 make
1546
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001547 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1548 make test
1549
1550 # In this configuration, the TLS test programs use HMAC_DRBG.
1551 # The SSL tests are slow, so run a small subset, just enough to get
1552 # confidence that the SSL code copes with HMAC_DRBG.
1553 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001554 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555
1556 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001557 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001558}
1559
1560component_test_no_hmac_drbg_classic () {
1561 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1562 scripts/config.py full
1563 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1564 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1565 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001566 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001567
Dave Rodgman17127e92023-12-14 16:42:48 +00001568 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001569 make
1570
1571 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001572 make test
1573
Gilles Peskinea2224342020-11-19 22:14:34 +01001574 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1575 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1576 # instead.
1577 # Test SSL with non-deterministic ECDSA. Only test features that
1578 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001579 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001580 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001581
1582 # To save time, only test one protocol version, since this part of
1583 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001585 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001586}
1587
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001588component_test_no_hmac_drbg_use_psa () {
1589 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1590 scripts/config.py full
1591 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1592 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1593 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1594
Dave Rodgman17127e92023-12-14 16:42:48 +00001595 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001596 make
1597
1598 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1599 make test
1600
1601 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1602 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1603 # instead.
1604 # Test SSL with non-deterministic ECDSA. Only test features that
1605 # might be affected by how ECDSA signature is performed.
1606 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001607 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001608
1609 # To save time, only test one protocol version, since this part of
1610 # the protocol is identical in (D)TLS up to 1.2.
1611 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001612 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001613}
1614
1615component_test_psa_external_rng_no_drbg_classic () {
1616 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1617 scripts/config.py full
1618 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001619 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001620 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001621 scripts/config.py unset MBEDTLS_ENTROPY_C
1622 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1623 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001624 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1625 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1626 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001627 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1628 # the SSL test programs don't have an RNG and can't work. Explicitly
1629 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001630 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001631
1632 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1633 make test
1634
Gilles Peskine8eb29432021-02-03 20:07:11 +01001635 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001636 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001637}
1638
1639component_test_psa_external_rng_no_drbg_use_psa () {
1640 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001641 scripts/config.py full
1642 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001643 scripts/config.py unset MBEDTLS_ENTROPY_C
1644 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1645 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001646 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1647 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1648 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001649 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001650
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001651 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001652 make test
1653
Gilles Peskine8eb29432021-02-03 20:07:11 +01001654 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001655 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001656}
1657
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001658component_test_psa_external_rng_use_psa_crypto () {
1659 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1660 scripts/config.py full
1661 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1662 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1663 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001664 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001665
1666 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1667 make test
1668
1669 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1670 tests/ssl-opt.sh -f 'Default\|opaque'
1671}
1672
Gilles Peskine801c4332023-04-28 21:04:28 +02001673component_test_psa_inject_entropy () {
1674 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1675 scripts/config.py full
1676 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1677 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1678 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1679 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1680 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1681 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001682 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 +02001683
1684 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1685 make test
1686}
1687
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001688component_test_sw_inet_pton () {
1689 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1690
1691 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1692 scripts/config.py set MBEDTLS_TEST_HOOKS
1693 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1694
1695 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1696 make test
1697}
1698
Valerio Settia41654d2024-02-08 10:33:11 +01001699component_full_no_pkparse_pkwrite() {
1700 msg "build: full without pkparse and pkwrite"
1701
1702 scripts/config.py crypto_full
1703 scripts/config.py unset MBEDTLS_PK_PARSE_C
1704 scripts/config.py unset MBEDTLS_PK_WRITE_C
1705
Valerio Settia41654d2024-02-08 10:33:11 +01001706 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1707
1708 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
Ronald Cron709bbf02024-07-03 07:59:30 +02001709 not grep mbedtls_pk_parse_key ${BUILTIN_SRC_PATH}/pkparse.o
1710 not grep mbedtls_pk_write_key_der ${BUILTIN_SRC_PATH}/pkwrite.o
Valerio Settia41654d2024-02-08 10:33:11 +01001711
1712 msg "test: full without pkparse and pkwrite"
1713 make test
1714}
1715
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001716component_test_crypto_full_md_light_only () {
1717 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001718 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001719
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001720 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001721 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001722 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001723 scripts/config.py unset MBEDTLS_HKDF_C
1724 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001725 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001726 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001727 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001729 # Disable things that would auto-enable MD_C
1730 scripts/config.py unset MBEDTLS_PKCS5_C
1731
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001732 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1733 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001734 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001735
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001736 # Make sure we don't have the HMAC functions, but the hashing functions
Ronald Cron709bbf02024-07-03 07:59:30 +02001737 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1738 grep mbedtls_md ${BUILTIN_SRC_PATH}/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001739
1740 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001741 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001742}
1743
Ronald Cron8dbea482024-05-23 16:04:11 +02001744component_test_full_no_cipher () {
1745 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001746
1747 scripts/config.py full
1748 scripts/config.py unset MBEDTLS_CIPHER_C
1749
Ronald Cron8dbea482024-05-23 16:04:11 +02001750 # The built-in implementation of the following algs/key-types depends
1751 # on CIPHER_C so we disable them.
1752 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1753 # so we keep them enabled.
1754 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1755 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1756 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1757 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1758 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1759 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1760 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1761 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1762 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1763 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1764 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1765
Valerio Settic84d9402023-10-23 14:58:25 +02001766 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001767 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001768 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001769
Gilles Peskine21570cf2023-12-22 11:49:50 +01001770 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001771
Valerio Setti7e710e82023-08-25 09:14:15 +02001772 # Ensure that CIPHER_C was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02001773 not grep mbedtls_cipher_init ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti7e710e82023-08-25 09:14:15 +02001774
Ronald Cron8dbea482024-05-23 16:04:11 +02001775 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001776 make test
1777}
1778
Valerio Settibdfecb62023-11-07 15:37:20 +01001779component_test_full_no_ccm() {
1780 msg "build: full no PSA_WANT_ALG_CCM"
1781
1782 # Full config enables:
1783 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1784 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1785 scripts/config.py full
1786
1787 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1788 # enabled, but not used from TLS since USE_PSA is set.
1789 # This is helpful to ensure that TLS tests below have proper dependencies.
1790 #
1791 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1792 # PSA_WANT_ALG_CCM to be re-enabled.
1793 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1794
Gilles Peskine21570cf2023-12-22 11:49:50 +01001795 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001796
1797 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001798 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001799}
1800
1801component_test_full_no_ccm_star_no_tag() {
1802 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1803
1804 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1805 scripts/config.py full
1806
1807 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1808 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1809 # This basically disables all unauthenticated ciphers on the PSA side, while
1810 # keeping AEADs enabled.
1811 #
1812 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1813 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1814 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1815 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1816 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1817 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1818 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1819 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1820 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1821 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1822
Gilles Peskine21570cf2023-12-22 11:49:50 +01001823 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001824
1825 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Ronald Cron5b41a652024-07-03 08:59:47 +02001826 not grep mbedtls_psa_cipher ${PSA_CORE_PATH}/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001827
1828 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001829 make test
1830}
1831
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001832component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001833 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001834
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001835 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001836 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001837 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001838 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001839 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001840 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1841 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001842 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001843 scripts/config.py unset MBEDTLS_GCM_C
1844 scripts/config.py unset MBEDTLS_CCM_C
1845 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001846 #Disable TLS 1.3 (as no AEAD)
1847 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001848 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1849 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1850 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001851 # 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 +01001852 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001853 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001854 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001855 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001856 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1857 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001858 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001859 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001860 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001861
Przemek Stekiel9550c052022-09-28 09:51:55 +02001862 make
1863
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001864 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001865 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001866
1867 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001868}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001869
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001870component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001871 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001872
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001873 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001874 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001875 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001876 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001877 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001878 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1879 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001880 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001881 scripts/config.py unset MBEDTLS_GCM_C
1882 scripts/config.py unset MBEDTLS_CCM_C
1883 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001884 #Disable TLS 1.3 (as no AEAD)
1885 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001886 # 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 +01001887 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001888 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001889 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001890 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001891 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001892 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001893 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001894 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001895
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001896 make
1897
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001898 msg "test: default with only CBC-legacy cipher use psa"
1899 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001900
1901 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1902 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001903}
1904
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001905component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001906 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001907
1908 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001909 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001910 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001911 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001912 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001913 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1914 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001915 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001916 scripts/config.py unset MBEDTLS_GCM_C
1917 scripts/config.py unset MBEDTLS_CCM_C
1918 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001919 #Disable TLS 1.3 (as no AEAD)
1920 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001921 # 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 +01001922 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001923 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1924 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1925 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001926 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001927 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001928 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001929 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001930
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001931 make
1932
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001933 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001934 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001935
1936 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1937 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001938}
1939
Valerio Setti9f0ec532022-11-08 13:03:24 +01001940# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1941# that we could use for interop testing. However, we now have sort of two
1942# implementations ourselves: one using PSA, the other not. At least test that
1943# these two interoperate with each other.
1944component_test_tls1_2_ecjpake_compatibility() {
1945 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1946 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001947 # Explicitly make lib first to avoid a race condition:
1948 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1949 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001950 make -C programs ssl/ssl_server2 ssl/ssl_client2
1951 cp programs/ssl/ssl_server2 s2_no_use_psa
1952 cp programs/ssl/ssl_client2 c2_no_use_psa
1953
1954 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1955 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1956 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001957 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001958 make -C programs ssl/ssl_server2 ssl/ssl_client2
1959 make -C programs test/udp_proxy test/query_compile_time_config
1960
Valerio Setti70e02902022-12-02 16:21:56 +01001961 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1962 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1963 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1964 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1965 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1966 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1967 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1968 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 +01001969
1970 rm s2_no_use_psa c2_no_use_psa
1971}
1972
Gilles Peskine636c26a2020-03-04 20:46:15 +01001973component_test_everest () {
1974 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001975 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1976 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1977 make
1978
1979 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1980 make test
1981
Gilles Peskine6848d172023-11-02 19:58:03 +01001982 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001983 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001984
Gilles Peskine636c26a2020-03-04 20:46:15 +01001985 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001986 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001987
1988 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1989 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001990 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001991}
1992
Gilles Peskined3beca92020-07-03 00:15:37 +02001993component_test_everest_curve25519_only () {
1994 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001995 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02001996 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1997 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001998 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1999 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
2000 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02002001 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2002 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002003 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002004 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
2005
Gilles Peskined3beca92020-07-03 00:15:37 +02002006 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002007 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002008 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
2009 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02002010
Dave Rodgman17127e92023-12-14 16:42:48 +00002011 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002012
2013 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2014 make test
2015}
2016
Gilles Peskine8f073122018-11-27 15:58:47 +01002017component_test_small_ssl_out_content_len () {
2018 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002019 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2020 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002021 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002022 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002023
Gilles Peskine8f073122018-11-27 15:58:47 +01002024 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002025 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002026}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002027
Gilles Peskine8f073122018-11-27 15:58:47 +01002028component_test_small_ssl_in_content_len () {
2029 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002030 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2031 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002032 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002033 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002034
Gilles Peskine8f073122018-11-27 15:58:47 +01002035 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002036 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002037}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002038
Gilles Peskine8f073122018-11-27 15:58:47 +01002039component_test_small_ssl_dtls_max_buffering () {
2040 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002041 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002042 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002043 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002044
Gilles Peskine8f073122018-11-27 15:58:47 +01002045 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002046 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 +01002047}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002048
Gilles Peskine8f073122018-11-27 15:58:47 +01002049component_test_small_mbedtls_ssl_dtls_max_buffering () {
2050 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002051 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002052 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002053 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002054
Gilles Peskine8f073122018-11-27 15:58:47 +01002055 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002056 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002057}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002058
Gilles Peskine75cc7712019-09-06 19:47:17 +02002059component_test_psa_collect_statuses () {
2060 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002061 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002062 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002063 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002064 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002065 rm -f tests/statuses.log
2066}
2067
Gilles Peskine8f073122018-11-27 15:58:47 +01002068component_test_full_cmake_clang () {
2069 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002070 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002071 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 +01002072 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002073
k-stachowiak0291cb72019-06-26 15:52:12 +02002074 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002075 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002076
Gilles Peskineda6017c2022-10-30 21:02:40 +01002077 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2078 programs/test/cpp_dummy_build
2079
Gilles Peskine6848d172023-11-02 19:58:03 +01002080 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002081 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002082
Gilles Peskine82b27272019-06-14 18:27:03 +02002083 msg "program demos (full config, clang)" # ~10s
2084 tests/scripts/run_demos.py
2085
k-stachowiak0291cb72019-06-26 15:52:12 +02002086 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002087 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002088
Gilles Peskine8f073122018-11-27 15:58:47 +01002089 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002090 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002091}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002092
Gilles Peskine0c671602022-11-29 16:01:41 +01002093skip_suites_without_constant_flow () {
2094 # Skip the test suites that don't have any constant-flow annotations.
2095 # This will need to be adjusted if we ever start declaring things as
2096 # secret from macros or functions inside tests/include or tests/src.
2097 SKIP_TEST_SUITES=$(
2098 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2099 sed 's/test_suite_//; s/\.function$//' |
Ronald Cron635a2be2024-07-12 14:30:16 +02002100 tr '\n' ,),$(
2101 git -C tf-psa-crypto/tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2102 sed 's/test_suite_//; s/\.function$//' |
Gilles Peskine0c671602022-11-29 16:01:41 +01002103 tr '\n' ,)
2104 export SKIP_TEST_SUITES
2105}
2106
Dave Rodgman246210e2023-07-31 18:07:44 +01002107skip_all_except_given_suite () {
2108 # Skip all but the given test suite
2109 SKIP_TEST_SUITES=$(
2110 ls -1 tests/suites/test_suite_*.function |
2111 grep -v $1.function |
2112 sed 's/tests.suites.test_suite_//; s/\.function$//' |
Ronald Cron635a2be2024-07-12 14:30:16 +02002113 tr '\n' ,),$(
2114 ls -1 tf-psa-crypto/tests/suites/test_suite_*.function |
2115 grep -v $1.function |
2116 sed 's/tf-psa-crypto.tests.suites.test_suite_//; s/\.function$//' |
Dave Rodgman246210e2023-07-31 18:07:44 +01002117 tr '\n' ,)
2118 export SKIP_TEST_SUITES
2119}
2120
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002121component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002122 # This tests both (1) accesses to undefined memory, and (2) branches or
2123 # memory access depending on secret values. To distinguish between those:
2124 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2125 # - or alternatively, change the build type to MemSanDbg, which enables
2126 # origin tracking and nicer stack traces (which are useful for debugging
2127 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002128 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2129 scripts/config.py full
2130 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2131 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2132 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2133 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2134 make
2135
2136 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2137 make test
2138}
2139
2140component_test_memsan_constant_flow_psa () {
2141 # This tests both (1) accesses to undefined memory, and (2) branches or
2142 # memory access depending on secret values. To distinguish between those:
2143 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2144 # - or alternatively, change the build type to MemSanDbg, which enables
2145 # origin tracking and nicer stack traces (which are useful for debugging
2146 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002147 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002148 scripts/config.py full
2149 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2150 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2151 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2152 make
2153
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002154 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002155 make test
2156}
2157
Bence Szépkúti0354d042023-12-06 16:14:37 +01002158component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002159 # This tests both (1) everything that valgrind's memcheck usually checks
2160 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2161 # etc.) and (2) branches or memory access depending on secret values,
2162 # which will be reported as uninitialized memory. To distinguish between
2163 # secret and actually uninitialized:
2164 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2165 # - or alternatively, build with debug info and manually run the offending
2166 # test suite with valgrind --track-origins=yes, then check if the origin
2167 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002168 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2169 scripts/config.py full
2170 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2171 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002172 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002173 cmake -D CMAKE_BUILD_TYPE:String=Release .
2174 make
2175
2176 # this only shows a summary of the results (how many of each type)
2177 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002178 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002179 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002180
2181 # Test asm path in constant time module - by default, it will test the plain C
2182 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2183 msg "test: valgrind asm constant_time"
2184 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2185 skip_all_except_given_suite test_suite_constant_time
2186 cmake -D CMAKE_BUILD_TYPE:String=Release .
2187 make clean
2188 make
2189 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002190}
2191
Bence Szépkúti0354d042023-12-06 16:14:37 +01002192component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002193 # This tests both (1) everything that valgrind's memcheck usually checks
2194 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2195 # etc.) and (2) branches or memory access depending on secret values,
2196 # which will be reported as uninitialized memory. To distinguish between
2197 # secret and actually uninitialized:
2198 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2199 # - or alternatively, build with debug info and manually run the offending
2200 # test suite with valgrind --track-origins=yes, then check if the origin
2201 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002202 msg "build: cmake release GCC, full config with constant flow testing"
2203 scripts/config.py full
2204 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002205 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002206 cmake -D CMAKE_BUILD_TYPE:String=Release .
2207 make
2208
2209 # this only shows a summary of the results (how many of each type)
2210 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002211 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002212 make memcheck
2213}
2214
Janos Follath9338cac2023-10-04 18:55:39 +01002215component_test_tsan () {
2216 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002217 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002218 scripts/config.py set MBEDTLS_THREADING_C
2219 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002220 # Self-tests do not currently use multiple threads.
2221 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002222
Ryan6caf84f2024-03-05 13:57:00 +00002223 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2224 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2225
Janos Follath9338cac2023-10-04 18:55:39 +01002226 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2227 make
2228
2229 msg "test: main suites (TSan)"
2230 make test
2231}
2232
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002233component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002234 # Test that removing the deprecated features from the default
2235 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002236 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2237 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002238 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002239
2240 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2241 make test
2242}
2243
2244component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002245 msg "build: make, full_no_deprecated config" # ~ 30s
2246 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002247 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002248
Gilles Peskine30de2e82020-04-20 21:39:22 +02002249 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002250 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002251
2252 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2253 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002254}
2255
Gilles Peskine8386ea22020-04-30 09:07:29 +02002256component_test_full_no_deprecated_deprecated_warning () {
2257 # Test that there is nothing deprecated in "full_no_deprecated".
2258 # A deprecated feature would trigger a warning (made fatal) from
2259 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002260 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2261 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002262 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2263 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002264 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002265
Gilles Peskine30de2e82020-04-20 21:39:22 +02002266 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002267 make test
2268}
2269
Gilles Peskine8386ea22020-04-30 09:07:29 +02002270component_test_full_deprecated_warning () {
2271 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2272 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002273 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002274 scripts/config.py full
2275 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002276 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002277 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2278 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002279 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002280
Gilles Peskine8386ea22020-04-30 09:07:29 +02002281 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2282 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2283 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002284 # Expect warnings from '#warning' directives in check_config.h and
2285 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002286 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 +01002287
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002288 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2289 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002290
2291 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2292 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002293}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002294
Gilles Peskineec541fe2020-01-31 14:24:14 +01002295# Check that the specified libraries exist and are empty.
2296are_empty_libraries () {
2297 nm "$@" >/dev/null 2>/dev/null
2298 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2299}
2300
2301component_build_crypto_default () {
2302 msg "build: make, crypto only"
2303 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002304 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002305 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002306}
2307
2308component_build_crypto_full () {
2309 msg "build: make, crypto only, full config"
2310 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002311 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002312 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002313}
2314
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002315component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002316 msg "build: make, config for PSA crypto service"
2317 scripts/config.py crypto
2318 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2319 # Disable things that are not needed for just cryptography, to
2320 # reach a configuration that would be typical for a PSA cryptography
2321 # service providing all implemented PSA algorithms.
2322 # System stuff
2323 scripts/config.py unset MBEDTLS_ERROR_C
2324 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002325 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002326 # Crypto stuff with no PSA interface
2327 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002328 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002329 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002330 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002331 scripts/config.py unset MBEDTLS_NIST_KW_C
2332 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2333 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2334 scripts/config.py unset MBEDTLS_PKCS12_C
2335 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002336 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2337 # in PSA code to work with RSA keys. We don't require users to set those:
2338 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002339 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002340 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002341 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002342 make CFLAGS='-O1 -Werror' all test
2343 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2344}
2345
Gilles Peskineec541fe2020-01-31 14:24:14 +01002346component_build_crypto_baremetal () {
2347 msg "build: make, crypto only, baremetal config"
2348 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002349 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002350 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002351}
Daniel Axtens446af202020-09-02 21:30:13 +10002352support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002353 support_build_baremetal "$@"
2354}
2355
2356component_build_baremetal () {
2357 msg "build: make, baremetal config"
2358 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002359 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002360}
2361support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002362 # Older Glibc versions include time.h from other headers such as stdlib.h,
2363 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2364 # problem, Ubuntu 18.04 is ok.
2365 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2366}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002367
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002368# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002369component_test_depends_py_cipher_id () {
2370 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002371 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002372}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002373
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002374component_test_depends_py_cipher_chaining () {
2375 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002376 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002377}
2378
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002379component_test_depends_py_cipher_padding () {
2380 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002381 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002382}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002383
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002384component_test_depends_py_curves () {
2385 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002386 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002387}
2388
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002389component_test_depends_py_hashes () {
2390 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002391 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002392}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002393
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002394component_test_depends_py_kex () {
2395 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002396 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002397}
2398
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002399component_test_depends_py_pkalgs () {
2400 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002401 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002402}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002403
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002404# PSA equivalents of the depends.py tests
2405component_test_depends_py_cipher_id_psa () {
2406 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002407 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002408}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002409
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002410component_test_depends_py_cipher_chaining_psa () {
2411 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002412 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002413}
2414
2415component_test_depends_py_cipher_padding_psa () {
2416 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002417 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002418}
2419
2420component_test_depends_py_curves_psa () {
2421 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002422 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002423}
2424
2425component_test_depends_py_hashes_psa () {
2426 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002427 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002428}
2429
2430component_test_depends_py_kex_psa () {
2431 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002432 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002433}
2434
2435component_test_depends_py_pkalgs_psa () {
2436 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002437 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002438}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002439
Valerio Setti6bed64e2024-01-17 15:21:44 +01002440component_test_psa_crypto_config_ffdh_2048_only () {
2441 msg "build: full config - only DH 2048"
2442
2443 scripts/config.py full
2444
2445 # Disable all DH groups other than 2048.
2446 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2447 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2448 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2449 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2450
2451 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2452
2453 msg "test: full config - only DH 2048"
2454 make test
2455
2456 msg "ssl-opt: full config - only DH 2048"
2457 tests/ssl-opt.sh -f "ffdh"
2458}
2459
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002460component_build_no_pk_rsa_alt_support () {
2461 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2462
2463 scripts/config.py full
2464 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2465 scripts/config.py set MBEDTLS_RSA_C
2466 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2467
2468 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002469 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002470}
2471
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002472component_build_module_alt () {
2473 msg "build: MBEDTLS_XXX_ALT" # ~30s
2474 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002475
2476 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002477 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002478 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002479 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002480 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2481 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002482 # You can only have one threading implementation: alt or pthread, not both.
2483 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002484 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2485 # directly and assumes the implementation works with partial groups.
2486 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002487 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2488 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2489 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002490 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2491 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2492 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002493
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002494 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2495 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2496 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002497
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002498 # We can only compile, not link, since we don't have any implementations
2499 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002500 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002501}
2502
Gilles Peskine64996c32024-01-23 20:25:47 +01002503component_test_no_psa_crypto_full_cmake_asan() {
2504 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2505 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002506 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002507 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002508 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002509 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002510 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002511 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002512 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002513 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002514 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002515 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002516 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002517 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002518
Gilles Peskine64996c32024-01-23 20:25:47 +01002519 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002520 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002521
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002522 # Note: ssl-opt.sh has some test cases that depend on
2523 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2524 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002525 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002526 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002527
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002528 # Note: the next two invocations cover all compat.sh test cases.
2529 # We should use the same here and in basic-build-test.sh.
2530 msg "test: compat.sh: default version (full minus PSA crypto)"
2531 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002532
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002533 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002534 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002535}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002536
Ronald Cron403c15c2021-09-13 09:38:05 +02002537component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002538 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002539
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002540 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002541 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002542 $(helper_get_psa_key_type_list "ECC") \
2543 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002544
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002545 # Configure
2546 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002547
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002548 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002549 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002550
2551 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002552 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002553
2554 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002555 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2556 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2557
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002558 # Build
2559 # -----
2560
2561 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002562 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2563 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002564
2565 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2566
Valerio Setti3fe105b2023-10-30 11:08:12 +01002567 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002568
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002569 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002570 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002571
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002572 # Run the tests
2573 # -------------
2574
Ronald Cron403c15c2021-09-13 09:38:05 +02002575 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2576 make test
2577}
2578
Valerio Setti44b178c2023-03-22 14:02:57 +01002579component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002580 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002581
2582 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002583 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002584 $(helper_get_psa_key_type_list "ECC") \
2585 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002586
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002587 # Configure
2588 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002589
Ronald Cron46ac0652024-03-18 12:39:04 +01002590 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002591 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002592
Valerio Setti44b178c2023-03-22 14:02:57 +01002593 # Disable the module that's accelerated
2594 scripts/config.py unset MBEDTLS_ECDH_C
2595
2596 # Disable things that depend on it
2597 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2598 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2599 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2600 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2601 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2602
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002603 # Build
2604 # -----
2605
2606 helper_libtestdriver1_make_drivers "$loc_accel_list"
2607
Valerio Setti3fe105b2023-10-30 11:08:12 +01002608 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002609
Valerio Setti44b178c2023-03-22 14:02:57 +01002610 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002611 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002612
2613 # Run the tests
2614 # -------------
2615
Valerio Setti44b178c2023-03-22 14:02:57 +01002616 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002617 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002618}
2619
Przemek Stekieldccb2022023-05-11 10:48:50 +02002620component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002621 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002622
2623 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002624 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002625 $(helper_get_psa_key_type_list "DH") \
2626 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002627
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002628 # Configure
2629 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002630
Przemek Stekiel565353e2023-07-05 11:07:07 +02002631 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002632 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002633
2634 # Disable the module that's accelerated
2635 scripts/config.py unset MBEDTLS_DHM_C
2636
2637 # Disable things that depend on it
2638 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2639 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2640
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002641 # Build
2642 # -----
2643
2644 helper_libtestdriver1_make_drivers "$loc_accel_list"
2645
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002646 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002647
2648 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002649 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Przemek Stekieldccb2022023-05-11 10:48:50 +02002650
2651 # Run the tests
2652 # -------------
2653
Gilles Peskine14302ed2023-07-19 19:30:04 +02002654 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002655 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002656
Gilles Peskine14302ed2023-07-19 19:30:04 +02002657 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002658 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002659}
2660
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002661component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002662 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002663
2664 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002665 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002666
2667 # Disable things that are not supported
2668 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2669 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002670 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002671
Gilles Peskine14302ed2023-07-19 19:30:04 +02002672 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002673 make test
2674
Gilles Peskine14302ed2023-07-19 19:30:04 +02002675 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002676 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002677}
2678
Valerio Setti44b178c2023-03-22 14:02:57 +01002679component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002680 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002681
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002682 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002683 $(helper_get_psa_key_type_list "ECC") \
2684 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002685
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002686 # Configure
2687 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002688
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002689 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002690
2691 # Make built-in fallback not available
2692 scripts/config.py unset MBEDTLS_ECJPAKE_C
2693 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2694
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002695 # Build
2696 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002697
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002698 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002699
Valerio Setti3fe105b2023-10-30 11:08:12 +01002700 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002701
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002702 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002703 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002704
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002705 # Run the tests
2706 # -------------
2707
Gilles Peskine14302ed2023-07-19 19:30:04 +02002708 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002709 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002710}
2711
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002712component_test_psa_crypto_config_accel_ecc_some_key_types () {
2713 msg "build: full with accelerated EC algs and some key types"
2714
2715 # Algorithms and key types to accelerate
2716 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2717 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2718 ALG_ECDH \
2719 ALG_JPAKE \
2720 KEY_TYPE_ECC_PUBLIC_KEY \
2721 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2722 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002723 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2724 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002725
2726 # Configure
2727 # ---------
2728
2729 # start with config full for maximum coverage (also enables USE_PSA)
2730 helper_libtestdriver1_adjust_config "full"
2731
2732 # Disable modules that are accelerated - some will be re-enabled
2733 scripts/config.py unset MBEDTLS_ECDSA_C
2734 scripts/config.py unset MBEDTLS_ECDH_C
2735 scripts/config.py unset MBEDTLS_ECJPAKE_C
2736 scripts/config.py unset MBEDTLS_ECP_C
2737
2738 # Disable all curves - those that aren't accelerated should be re-enabled
2739 helper_disable_builtin_curves
2740
2741 # Restartable feature is not yet supported by PSA. Once it will in
2742 # the future, the following line could be removed (see issues
2743 # 6061, 6332 and following ones)
2744 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2745
2746 # this is not supported by the driver API yet
2747 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2748
2749 # Build
2750 # -----
2751
2752 # These hashes are needed for some ECDSA signature tests.
2753 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2754 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2755 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2756
Valerio Setti3fe105b2023-10-30 11:08:12 +01002757 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002758
2759 # ECP should be re-enabled but not the others
Ronald Cron709bbf02024-07-03 07:59:30 +02002760 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2761 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2762 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
2763 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002764
2765 # Run the tests
2766 # -------------
2767
2768 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002769 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002770}
2771
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002772# Run tests with only (non-)Weierstrass accelerated
2773# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002774# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2775# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002776common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002777 weierstrass=$1
2778 if [ $weierstrass -eq 1 ]; then
2779 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002780 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002781 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002782 fi
2783
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002784 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002785
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002786 # Note: Curves are handled in a special way by the libtestdriver machinery,
2787 # so we only want to include them in the accel list when building the main
2788 # libraries, hence the use of a separate variable.
2789 # Note: the following loop is a modified version of
2790 # helper_get_psa_curve_list that only keeps Weierstrass families.
2791 loc_weierstrass_list=""
2792 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002793 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2794 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002795 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002796 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002797 ;;
2798 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002799 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002800 ;;
2801 esac
2802 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002803 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002804 loc_curve_list=$loc_weierstrass_list
2805 else
2806 loc_curve_list=$loc_non_weierstrass_list
2807 fi
2808
Valerio Setti3fe105b2023-10-30 11:08:12 +01002809 # Algorithms and key types to accelerate
2810 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2811 ALG_ECDH \
2812 ALG_JPAKE \
2813 $(helper_get_psa_key_type_list "ECC") \
2814 $loc_curve_list"
2815
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002816 # Configure
2817 # ---------
2818
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002819 # Start with config crypto_full and remove PK_C:
2820 # that's what's supported now, see docs/driver-only-builds.md.
2821 helper_libtestdriver1_adjust_config "crypto_full"
2822 scripts/config.py unset MBEDTLS_PK_C
2823 scripts/config.py unset MBEDTLS_PK_PARSE_C
2824 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002825
2826 # Disable modules that are accelerated - some will be re-enabled
2827 scripts/config.py unset MBEDTLS_ECDSA_C
2828 scripts/config.py unset MBEDTLS_ECDH_C
2829 scripts/config.py unset MBEDTLS_ECJPAKE_C
2830 scripts/config.py unset MBEDTLS_ECP_C
2831
2832 # Disable all curves - those that aren't accelerated should be re-enabled
2833 helper_disable_builtin_curves
2834
2835 # Restartable feature is not yet supported by PSA. Once it will in
2836 # the future, the following line could be removed (see issues
2837 # 6061, 6332 and following ones)
2838 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2839
2840 # this is not supported by the driver API yet
2841 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2842
2843 # Build
2844 # -----
2845
2846 # These hashes are needed for some ECDSA signature tests.
2847 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2848 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2849 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2850
Valerio Settiac7a8092023-10-31 12:23:44 +01002851 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002852
2853 # We expect ECDH to be re-enabled for the missing curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002854 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002855 # We expect ECP to be re-enabled, however the parts specific to the
2856 # families of curves that are accelerated should be ommited.
2857 # - functions with mxz in the name are specific to Montgomery curves
2858 # - ecp_muladd is specific to Weierstrass curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002859 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002860 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002861 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2862 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002863 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002864 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2865 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002866 fi
2867 # We expect ECDSA and ECJPAKE to be re-enabled only when
2868 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002869 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002870 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2871 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002872 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002873 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2874 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002875 fi
2876
2877 # Run the tests
2878 # -------------
2879
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002880 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2881 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002882}
2883
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002884component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002885 common_test_psa_crypto_config_accel_ecc_some_curves 1
2886}
2887
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002888component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002889 common_test_psa_crypto_config_accel_ecc_some_curves 0
2890}
2891
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002892# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2893# ECDH, ECDSA) with and without drivers.
2894# The input parameter is a boolean value which indicates:
2895# - 0 keep built-in EC algs,
2896# - 1 exclude built-in EC algs (driver only).
2897#
2898# This is used by the two following components to ensure they always use the
2899# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002900# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2901# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002902# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002903config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002904 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002905 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002906 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002907 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002908 # Disable modules that are accelerated
2909 scripts/config.py unset MBEDTLS_ECDSA_C
2910 scripts/config.py unset MBEDTLS_ECDH_C
2911 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002912 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002913 fi
2914
2915 # Restartable feature is not yet supported by PSA. Once it will in
2916 # the future, the following line could be removed (see issues
2917 # 6061, 6332 and following ones)
2918 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002919}
2920
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002921# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2922component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002923 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002924
2925 # Algorithms and key types to accelerate
2926 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2927 ALG_ECDH \
2928 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002929 $(helper_get_psa_key_type_list "ECC") \
2930 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002931
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002932 # Configure
2933 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002934
2935 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002936 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002937
Valerio Setti0a342c92023-09-01 09:12:31 +02002938 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002939 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2940 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002941
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002942 # Build
2943 # -----
2944
2945 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002946 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2947 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002948 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2949
Valerio Setti3fe105b2023-10-30 11:08:12 +01002950 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002951
2952 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002953 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
2954 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2955 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
2956 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002957
2958 # Run the tests
2959 # -------------
2960
Gilles Peskine14302ed2023-07-19 19:30:04 +02002961 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002962 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002963
Gilles Peskine14302ed2023-07-19 19:30:04 +02002964 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002965 tests/ssl-opt.sh
2966}
2967
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002968# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2969component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002970 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002971
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002972 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002973
Gilles Peskine21570cf2023-12-22 11:49:50 +01002974 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002975
Gilles Peskine14302ed2023-07-19 19:30:04 +02002976 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002977 make test
2978
Gilles Peskine14302ed2023-07-19 19:30:04 +02002979 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002980 tests/ssl-opt.sh
2981}
2982
Valerio Settie618cb02023-04-12 14:59:16 +02002983# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002984# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2985# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002986# to ensure that both tests use the same underlying configuration when testing
2987# driver's coverage with analyze_outcomes.py.
2988#
2989# This functions accepts 1 boolean parameter as follows:
2990# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2991# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2992# - 0: include built-in implementation of EC algorithms.
2993#
2994# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2995# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002996config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002997 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002998 # start with full config for maximum coverage (also enables USE_PSA)
2999 helper_libtestdriver1_adjust_config "full"
3000
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003001 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003002 # Disable modules that are accelerated
3003 scripts/config.py unset MBEDTLS_ECDSA_C
3004 scripts/config.py unset MBEDTLS_ECDH_C
3005 scripts/config.py unset MBEDTLS_ECJPAKE_C
3006 # Disable ECP module (entirely)
3007 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003008 fi
3009
Valerio Settiaecd32c2023-06-14 10:42:31 +02003010 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3011 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003012 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003013 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003014
Valerio Settie618cb02023-04-12 14:59:16 +02003015 # Restartable feature is not yet supported by PSA. Once it will in
3016 # the future, the following line could be removed (see issues
3017 # 6061, 6332 and following ones)
3018 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003019}
3020
3021# Build and test a configuration where driver accelerates all EC algs while
3022# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3023# side.
3024#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003025# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3026component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003027 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003028
3029 # Algorithms and key types to accelerate
3030 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3031 ALG_ECDH \
3032 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003033 $(helper_get_psa_key_type_list "ECC") \
3034 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003035
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003036 # Configure
3037 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003038
Valerio Settie618cb02023-04-12 14:59:16 +02003039 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003040 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003041 # Disable all the builtin curves. All the required algs are accelerated.
3042 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003043
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003044 # Build
3045 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003046
3047 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003048 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3049 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3050 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003051
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003052 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003053
Valerio Setti3fe105b2023-10-30 11:08:12 +01003054 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003055
3056 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003057 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3058 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3059 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003060 # Also ensure that ECP module was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003061 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003062
3063 # Run the tests
3064 # -------------
3065
Gilles Peskine14302ed2023-07-19 19:30:04 +02003066 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003067 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003068
Gilles Peskine14302ed2023-07-19 19:30:04 +02003069 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003070 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003071}
3072
3073# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003074# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003075# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003076component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003077 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003078
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003079 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003080
Gilles Peskine21570cf2023-12-22 11:49:50 +01003081 make
Valerio Settie618cb02023-04-12 14:59:16 +02003082
Gilles Peskine14302ed2023-07-19 19:30:04 +02003083 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003084 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003085
Gilles Peskine14302ed2023-07-19 19:30:04 +02003086 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003087 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003088}
3089
Valerio Setti4e2f2442023-08-15 10:10:26 +02003090# This is a common configuration helper used directly from:
3091# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3092# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3093# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003094# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003095# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003096# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003097# - this is the reference component of the above
3098# - it still disables RSA and FFDH, but it uses builtin EC algs
3099# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3100# - accelerate all EC and FFDH algs, disable only RSA
3101# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3102# - this is the reference component of the above
3103# - it still disables RSA, but it uses builtin EC and FFDH algs
3104#
3105# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003106# $1: a boolean value which states if we are testing an accelerated scenario
3107# or not.
3108# $2: a string value which states which components are tested. Allowed values
3109# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003110config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003111 driver_only="$1"
3112 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003113 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003114 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003115
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003116 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003117 # Disable modules that are accelerated
3118 scripts/config.py unset MBEDTLS_ECDSA_C
3119 scripts/config.py unset MBEDTLS_ECDH_C
3120 scripts/config.py unset MBEDTLS_ECJPAKE_C
3121 # Disable ECP module (entirely)
3122 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003123 # Also disable bignum
3124 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003125 fi
3126
3127 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3128 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3129 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3130 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3131
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003132 # RSA support is intentionally disabled on this test because RSA_C depends
3133 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003134 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3135 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 +02003136 scripts/config.py unset MBEDTLS_RSA_C
3137 scripts/config.py unset MBEDTLS_PKCS1_V15
3138 scripts/config.py unset MBEDTLS_PKCS1_V21
3139 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3140 # Also disable key exchanges that depend on RSA
3141 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3142 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3143 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3144 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3145 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3146
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003147 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003148 # When testing ECC only, we disable FFDH support, both from builtin and
3149 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003150 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003151 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 +01003152 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003153 scripts/config.py unset MBEDTLS_DHM_C
3154 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3155 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3156 else
3157 # When testing ECC and DH instead, we disable DHM and depending key
3158 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003159 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003160 scripts/config.py unset MBEDTLS_DHM_C
3161 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3162 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3163 fi
3164 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003165
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003166 # Restartable feature is not yet supported by PSA. Once it will in
3167 # the future, the following line could be removed (see issues
3168 # 6061, 6332 and following ones)
3169 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3170}
3171
Valerio Setti4e2f2442023-08-15 10:10:26 +02003172# Common helper used by:
3173# - component_test_psa_crypto_config_accel_ecc_no_bignum
3174# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003175#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003176# The goal is to build and test accelerating either:
3177# - ECC only or
3178# - both ECC and FFDH
3179#
3180# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003181# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3182# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003183common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003184 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003185
Valerio Setti5dfaca42023-09-05 08:48:51 +02003186 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003187 if [ "$test_target" = "ECC_DH" ]; then
3188 accel_text="ECC/FFDH"
3189 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003190 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003191 accel_text="ECC"
3192 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003193 fi
3194
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003195 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003196
3197 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003198 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3199 ALG_ECDH \
3200 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003201 $(helper_get_psa_key_type_list "ECC") \
3202 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003203 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003204 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003205 loc_accel_list="$loc_accel_list \
3206 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003207 $(helper_get_psa_key_type_list "DH") \
3208 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003209 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003210
3211 # Configure
3212 # ---------
3213
3214 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003215 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003216 # Disable all the builtin curves. All the required algs are accelerated.
3217 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003218
3219 # Build
3220 # -----
3221
3222 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003223 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3224 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3225 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003226
3227 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3228
Valerio Setti3fe105b2023-10-30 11:08:12 +01003229 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003230
3231 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003232 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3233 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3234 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003235 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003236 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3237 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3238 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
3239 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003240
3241 # Run the tests
3242 # -------------
3243
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003244 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003245
Gilles Peskine21570cf2023-12-22 11:49:50 +01003246 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003247
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003248 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003249 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003250}
3251
Valerio Setti4e2f2442023-08-15 10:10:26 +02003252# Common helper used by:
3253# - component_test_psa_crypto_config_reference_ecc_no_bignum
3254# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3255#
3256# The goal is to build and test a reference scenario (i.e. with builtin
3257# components) compared to the ones used in
3258# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3259#
3260# It is meant to be used in conjunction with
3261# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3262# coverage analysis in "analyze_outcomes.py" script.
3263common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003264 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003265
Valerio Setti5dfaca42023-09-05 08:48:51 +02003266 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003267 if [ "$test_target" = "ECC_DH" ]; then
3268 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003269 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003270 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003271 fi
3272
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003273 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003274
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003275 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003276
Gilles Peskine21570cf2023-12-22 11:49:50 +01003277 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003278
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003279 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003280 make test
3281
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003282 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003283 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003284}
3285
Valerio Setti4e2f2442023-08-15 10:10:26 +02003286component_test_psa_crypto_config_accel_ecc_no_bignum () {
3287 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3288}
3289
3290component_test_psa_crypto_config_reference_ecc_no_bignum () {
3291 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3292}
3293
3294component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3295 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3296}
3297
3298component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3299 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3300}
3301
Valerio Settiac6d35f2023-08-04 12:49:11 +02003302# Helper for setting common configurations between:
3303# - component_test_tfm_config_p256m_driver_accel_ec()
3304# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003305common_tfm_config () {
3306 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003307 cp configs/config-tfm.h "$CONFIG_H"
3308 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3309 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003310
Yanray Wang73bb2312023-09-25 11:21:15 +08003311 # Other config adjustment to make the tests pass.
3312 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003313 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003314 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3315 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003316
Yanray Wang73bb2312023-09-25 11:21:15 +08003317 # Config adjustment for better test coverage in our environment.
3318 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003319 #
3320 # Enable filesystem I/O for the benefit of PK parse/write tests.
3321 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3322}
3323
Valerio Settiac6d35f2023-08-04 12:49:11 +02003324# Keep this in sync with component_test_tfm_config() as they are both meant
3325# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003326component_test_tfm_config_p256m_driver_accel_ec () {
3327 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3328
3329 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003330
Dave Rodgman897bb772023-11-15 16:34:20 +00003331 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003332 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003333
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003334 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003335 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3336 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3337 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib7e95442023-03-21 11:52:33 +01003338 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003339 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3340 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3341 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
3342 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003343 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003344 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003345
Valerio Setti5e18b902023-12-04 12:07:30 +01003346 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3347 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003348 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003349
Valerio Settib7e95442023-03-21 11:52:33 +01003350 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003351 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003352 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003353}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003354
Valerio Settiac6d35f2023-08-04 12:49:11 +02003355# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3356# they are both meant to be used in analyze_outcomes.py for driver's coverage
3357# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003358component_test_tfm_config() {
3359 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003360
Dave Rodgman897bb772023-11-15 16:34:20 +00003361 # Disable P256M driver, which is on by default, so that analyze_outcomes
3362 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3363 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3364
Valerio Setti52ba0e32023-08-04 12:43:03 +02003365 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003366 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003367
Dave Rodgman897bb772023-11-15 16:34:20 +00003368 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003369 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003370
Valerio Setti5e18b902023-12-04 12:07:30 +01003371 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3372 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003373 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003374
Valerio Setti52ba0e32023-08-04 12:43:03 +02003375 msg "test: TF-M config"
3376 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003377}
3378
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003379# Common helper for component_full_without_ecdhe_ecdsa() and
3380# component_full_without_ecdhe_ecdsa_and_tls13() which:
3381# - starts from the "full" configuration minus the list of symbols passed in
3382# as 1st parameter
3383# - build
3384# - test only TLS (i.e. test_suite_tls and ssl-opt)
3385build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003386 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003387
3388 msg "build: full minus something, test TLS"
3389
3390 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003391 for sym in $symbols_to_disable; do
3392 echo "Disabling $sym"
3393 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003394 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003395
Gilles Peskine21570cf2023-12-22 11:49:50 +01003396 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003397
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003398 msg "test: full minus something, test TLS"
3399 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003400
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003401 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003402 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003403}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003404
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003405component_full_without_ecdhe_ecdsa () {
3406 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003407}
3408
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003409component_full_without_ecdhe_ecdsa_and_tls13 () {
3410 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3411 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003412}
3413
Valerio Setti249b18a2023-06-20 12:08:30 +02003414# This is an helper used by:
3415# - component_test_psa_ecc_key_pair_no_derive
3416# - component_test_psa_ecc_key_pair_no_generate
3417# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3418# enabled, but one. Input arguments are as follows:
3419# - $1 is the key type under test, i.e. ECC/RSA/DH
3420# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003421build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003422 key_type=$1
3423 unset_option=$2
3424 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003425
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003426 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003427 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003428 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3429 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3430
3431 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3432 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003433 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003434
Gilles Peskine21570cf2023-12-22 11:49:50 +01003435 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003436
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003437 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003438 make test
3439}
3440
3441component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003442 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003443}
3444
3445component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003446 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003447}
3448
Pengyu Lve705f572023-12-06 16:38:15 +08003449config_psa_crypto_accel_rsa () {
3450 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003451
Pengyu Lve705f572023-12-06 16:38:15 +08003452 # Start from crypto_full config (no X.509, no TLS)
3453 helper_libtestdriver1_adjust_config "crypto_full"
3454
3455 if [ "$driver_only" -eq 1 ]; then
3456 # Remove RSA support and its dependencies
3457 scripts/config.py unset MBEDTLS_RSA_C
3458 scripts/config.py unset MBEDTLS_PKCS1_V15
3459 scripts/config.py unset MBEDTLS_PKCS1_V21
3460
3461 # We need PEM parsing in the test library as well to support the import
3462 # of PEM encoded RSA keys.
3463 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3464 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3465 fi
3466}
3467
3468component_test_psa_crypto_config_accel_rsa_crypto () {
3469 msg "build: crypto_full with accelerated RSA"
3470
3471 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3472 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3473 KEY_TYPE_RSA_PUBLIC_KEY \
3474 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3475 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3476 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3477 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003478
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003479 # Configure
3480 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003481
Pengyu Lve705f572023-12-06 16:38:15 +08003482 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003483
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003484 # Build
3485 # -----
3486
Pengyu Lve705f572023-12-06 16:38:15 +08003487 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003488 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 +08003489 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003490 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003491
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003492 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003493
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003494 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003495 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003496
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003497 # Run the tests
3498 # -------------
3499
Pengyu Lve705f572023-12-06 16:38:15 +08003500 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003501 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003502}
3503
3504component_test_psa_crypto_config_reference_rsa_crypto () {
3505 msg "build: crypto_full with non-accelerated RSA"
3506
3507 # Configure
3508 # ---------
3509 config_psa_crypto_accel_rsa 0
3510
3511 # Build
3512 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003513 make
Pengyu Lve705f572023-12-06 16:38:15 +08003514
3515 # Run the tests
3516 # -------------
3517 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003518 make test
3519}
3520
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003521# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003522# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003523component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003524 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003525
Valerio Setti4590bc22023-06-13 15:39:23 +02003526 # Create a temporary output file unless there is already one set
3527 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3528 REMOVE_OUTCOME_ON_EXIT="no"
3529 else
3530 REMOVE_OUTCOME_ON_EXIT="yes"
3531 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3532 export MBEDTLS_TEST_OUTCOME_FILE
3533 fi
3534
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003535 # Start from crypto configuration
3536 scripts/config.py crypto
3537
3538 # Remove RSA support and its dependencies
3539 scripts/config.py unset MBEDTLS_PKCS1_V15
3540 scripts/config.py unset MBEDTLS_PKCS1_V21
3541 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3542 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3543 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3544 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3545 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3546 scripts/config.py unset MBEDTLS_RSA_C
3547 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3548
3549 # Enable PSA support
3550 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3551
Valerio Setti01cc88a2023-06-15 11:53:08 +02003552 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003553 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003554 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3555 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3556 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003557
3558 make
3559
Valerio Setti01cc88a2023-06-15 11:53:08 +02003560 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003561 make test
3562
3563 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3564 # performing RSA signature.
3565 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3566 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3567
3568 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3569 rm $MBEDTLS_TEST_OUTCOME_FILE
3570 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003571}
3572
Ronald Cronb2312452021-05-08 14:32:59 +02003573component_test_psa_crypto_config_accel_hash () {
3574 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3575
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003576 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3577 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3578 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003579
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003580 # Configure
3581 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003582
Ronald Cron46ac0652024-03-18 12:39:04 +01003583 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003584 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003585
3586 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003587 scripts/config.py unset MBEDTLS_MD5_C
3588 scripts/config.py unset MBEDTLS_RIPEMD160_C
3589 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003590 scripts/config.py unset MBEDTLS_SHA224_C
3591 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003592 scripts/config.py unset MBEDTLS_SHA384_C
3593 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003594 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003595
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003596 # Build
3597 # -----
3598
3599 helper_libtestdriver1_make_drivers "$loc_accel_list"
3600
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003601 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003602
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003603 # There's a risk of something getting re-enabled via config_psa.h;
3604 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003605 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3606 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3607 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3608 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3609 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003610
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003611 # Run the tests
3612 # -------------
3613
Ronald Cronb2312452021-05-08 14:32:59 +02003614 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3615 make test
3616}
3617
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003618# Auxiliary function to build config for hashes with and without drivers
3619config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003620 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003621 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003622 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003623 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003624 # disable the built-in implementation of hashes
3625 scripts/config.py unset MBEDTLS_MD5_C
3626 scripts/config.py unset MBEDTLS_RIPEMD160_C
3627 scripts/config.py unset MBEDTLS_SHA1_C
3628 scripts/config.py unset MBEDTLS_SHA224_C
3629 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003630 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003631 scripts/config.py unset MBEDTLS_SHA384_C
3632 scripts/config.py unset MBEDTLS_SHA512_C
3633 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003634 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003635 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003636}
3637
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003638# Note that component_test_psa_crypto_config_reference_hash_use_psa
3639# is related to this component and both components need to be kept in sync.
3640# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003641component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003642 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003643
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003644 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3645 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3646 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003647
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003648 # Configure
3649 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003650
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003651 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003652
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003653 # Build
3654 # -----
3655
3656 helper_libtestdriver1_make_drivers "$loc_accel_list"
3657
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003658 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003659
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003660 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003661 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003662 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3663 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3664 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3665 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3666 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003667
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003668 # Run the tests
3669 # -------------
3670
Gilles Peskine14302ed2023-07-19 19:30:04 +02003671 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003672 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003673
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003674 # This is mostly useful so that we can later compare outcome files with
3675 # the reference config in analyze_outcomes.py, to check that the
3676 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003677 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003678 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003679
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003680 # This is to make sure all ciphersuites are exercised, but we don't need
3681 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003682 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003683 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003684}
3685
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003686# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3687# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3688# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3689# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003690component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003691 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003692
3693 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003694
Gilles Peskine21570cf2023-12-22 11:49:50 +01003695 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003696
Gilles Peskine14302ed2023-07-19 19:30:04 +02003697 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003698 make test
3699
Gilles Peskine14302ed2023-07-19 19:30:04 +02003700 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003701 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003702}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003703
Valerio Setti8eb310c2024-01-22 16:22:57 +01003704# Auxiliary function to build config for hashes with and without drivers
3705config_psa_crypto_hmac_use_psa () {
3706 driver_only="$1"
3707 # start with config full for maximum coverage (also enables USE_PSA)
3708 helper_libtestdriver1_adjust_config "full"
3709
Valerio Setticd89b0b2024-01-24 14:24:55 +01003710 if [ "$driver_only" -eq 1 ]; then
3711 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3712 # is still enabled though (for ENTROPY_C among others).
3713 scripts/config.py unset MBEDTLS_MD_C
3714 # Disable also the builtin hashes since they are supported by the driver
3715 # and MD module is able to perform PSA dispathing.
3716 scripts/config.py unset-all MBEDTLS_SHA
3717 scripts/config.py unset MBEDTLS_MD5_C
3718 scripts/config.py unset MBEDTLS_RIPEMD160_C
3719 fi
3720
Valerio Setti8eb310c2024-01-22 16:22:57 +01003721 # Direct dependencies of MD_C. We disable them also in the reference
3722 # component to work with the same set of features.
3723 scripts/config.py unset MBEDTLS_PKCS7_C
3724 scripts/config.py unset MBEDTLS_PKCS5_C
3725 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3726 scripts/config.py unset MBEDTLS_HKDF_C
3727 # Dependencies of HMAC_DRBG
3728 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3729 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3730}
3731
3732component_test_psa_crypto_config_accel_hmac() {
3733 msg "test: full with accelerated hmac"
3734
3735 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3736 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3737 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3738 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3739
3740 # Configure
3741 # ---------
3742
3743 config_psa_crypto_hmac_use_psa 1
3744
Valerio Setti8eb310c2024-01-22 16:22:57 +01003745 # Build
3746 # -----
3747
3748 helper_libtestdriver1_make_drivers "$loc_accel_list"
3749
3750 helper_libtestdriver1_make_main "$loc_accel_list"
3751
3752 # Ensure that built-in support for HMAC is disabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003753 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
Valerio Setti8eb310c2024-01-22 16:22:57 +01003754
3755 # Run the tests
3756 # -------------
3757
3758 msg "test: full with accelerated hmac"
3759 make test
3760}
3761
3762component_test_psa_crypto_config_reference_hmac() {
3763 msg "test: full without accelerated hmac"
3764
3765 config_psa_crypto_hmac_use_psa 0
3766
3767 make
3768
3769 msg "test: full without accelerated hmac"
3770 make test
3771}
3772
Valerio Setti9da01a72023-12-18 17:38:18 +01003773component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003774 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003775
Valerio Setti9da01a72023-12-18 17:38:18 +01003776 # Albeit this components aims at accelerating DES which should only support
3777 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3778 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003779 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3780 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3781 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003782
Valerio Setti9da01a72023-12-18 17:38:18 +01003783 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3784 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3785 # of this component. This limitation will be addressed by #8598.
3786
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003787 # Configure
3788 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003789
Valerio Setti9a427302023-10-17 11:40:42 +02003790 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003791 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003792
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003793 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003794 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3795 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3796 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3797 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3798 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3799 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3800 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003801 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003802
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003803 # Build
3804 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003805
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003806 helper_libtestdriver1_make_drivers "$loc_accel_list"
3807
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003808 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003809
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003810 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003811 not grep mbedtls_des* ${BUILTIN_SRC_PATH}/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003812
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003813 # Run the tests
3814 # -------------
3815
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003816 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003817 make test
3818}
3819
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003820component_test_psa_crypto_config_accel_aead () {
3821 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3822
Valerio Setti3f02bb72023-10-02 15:57:33 +02003823 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3824 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003825
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003826 # Configure
3827 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003828
Valerio Setti3f02bb72023-10-02 15:57:33 +02003829 # Start from full config
3830 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003831
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003832 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003833 scripts/config.py unset MBEDTLS_GCM_C
3834 scripts/config.py unset MBEDTLS_CCM_C
3835 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003836
Valerio Settia50b89e2023-11-08 15:58:47 +01003837 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003839
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003840 # Build
3841 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003842
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003843 helper_libtestdriver1_make_drivers "$loc_accel_list"
3844
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003845 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003846
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003847 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003848 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3849 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3850 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
Przemek Stekielee1bb412022-10-11 11:52:25 +02003851
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003852 # Run the tests
3853 # -------------
3854
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003855 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3856 make test
3857}
3858
Valerio Settib680fc42023-10-13 09:29:37 +02003859# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003860# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3861# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3862common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003863 # Start from the full config
3864 helper_libtestdriver1_adjust_config "full"
3865
Valerio Settib680fc42023-10-13 09:29:37 +02003866 scripts/config.py unset MBEDTLS_NIST_KW_C
3867}
3868
Valerio Settib6b301f2023-10-04 12:05:05 +02003869# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003870# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3871# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003872# are meant to be used together in analyze_outcomes.py script in order to test
3873# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003874component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3875 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003876
Valerio Settiad8b7f02023-10-25 12:39:50 +02003877 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 +01003878 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003879 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003880 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3881
3882 # Configure
3883 # ---------
3884
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003885 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003886
3887 # Disable the things that are being accelerated
3888 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3889 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3890 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3891 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3892 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3893 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3894 scripts/config.py unset MBEDTLS_GCM_C
3895 scripts/config.py unset MBEDTLS_CCM_C
3896 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003897 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003898 scripts/config.py unset MBEDTLS_DES_C
3899 scripts/config.py unset MBEDTLS_AES_C
3900 scripts/config.py unset MBEDTLS_ARIA_C
3901 scripts/config.py unset MBEDTLS_CHACHA20_C
3902 scripts/config.py unset MBEDTLS_CAMELLIA_C
3903
Valerio Settiec9b2582023-11-08 16:50:54 +01003904 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3905 # does not depend on it.
3906 scripts/config.py unset MBEDTLS_CIPHER_C
3907
Valerio Settib6b301f2023-10-04 12:05:05 +02003908 # Build
3909 # -----
3910
3911 helper_libtestdriver1_make_drivers "$loc_accel_list"
3912
3913 helper_libtestdriver1_make_main "$loc_accel_list"
3914
3915 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003916 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
3917 not grep mbedtls_des ${BUILTIN_SRC_PATH}/des.o
3918 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
3919 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
3920 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
3921 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3922 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3923 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
3924 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003925
3926 # Run the tests
3927 # -------------
3928
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003929 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003930 make test
Valerio Settif9414552023-11-09 10:43:20 +01003931
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003932 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003933 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003934
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003935 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003936 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003937}
3938
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003939component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3940 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3941 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003942
Gilles Peskine21570cf2023-12-22 11:49:50 +01003943 make
Valerio Settif9414552023-11-09 10:43:20 +01003944
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003945 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003946 make test
Valerio Settif9414552023-11-09 10:43:20 +01003947
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003948 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003949 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003950
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003951 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003952 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003953}
3954
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003955common_block_cipher_dispatch() {
3956 TEST_WITH_DRIVER="$1"
3957
3958 # Start from the full config
3959 helper_libtestdriver1_adjust_config "full"
3960
3961 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3962 # Disable key types that are accelerated (there is no legacy equivalent
3963 # symbol for ECB)
3964 scripts/config.py unset MBEDTLS_AES_C
3965 scripts/config.py unset MBEDTLS_ARIA_C
3966 scripts/config.py unset MBEDTLS_CAMELLIA_C
3967 fi
3968
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003969 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003970 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003971 # Keep this also in the reference component in order to skip the same tests
3972 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003973 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
3974 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
3975 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
3976 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
3977 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
3978 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
3979 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02003980 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003981
3982 # Disable direct dependency on AES_C
3983 scripts/config.py unset MBEDTLS_NIST_KW_C
3984
3985 # Prevent the cipher module from using deprecated PSA path. The reason is
3986 # that otherwise there will be tests relying on "aes_info" (defined in
3987 # "cipher_wrap.c") whose functions are not available when AES_C is
3988 # not defined. ARIA and Camellia are not a problem in this case because
3989 # the PSA path is not tested for these key types.
3990 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
3991}
3992
Valerio Settif8e6cba2023-12-12 11:53:39 +01003993component_test_full_block_cipher_psa_dispatch () {
3994 msg "build: full + PSA dispatch in block_cipher"
3995
3996 loc_accel_list="ALG_ECB_NO_PADDING \
3997 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
3998
3999 # Configure
4000 # ---------
4001
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004002 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004003
Valerio Settif8e6cba2023-12-12 11:53:39 +01004004 # Build
4005 # -----
4006
4007 helper_libtestdriver1_make_drivers "$loc_accel_list"
4008
4009 helper_libtestdriver1_make_main "$loc_accel_list"
4010
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004011 # Make sure disabled components were not re-enabled by accident (additive
4012 # config)
Ronald Cron709bbf02024-07-03 07:59:30 +02004013 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
4014 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
4015 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004016
Valerio Settif8e6cba2023-12-12 11:53:39 +01004017 # Run the tests
4018 # -------------
4019
4020 msg "test: full + PSA dispatch in block_cipher"
4021 make test
4022}
4023
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004024# This is the reference component of component_test_full_block_cipher_psa_dispatch
4025component_test_full_block_cipher_legacy_dispatch () {
4026 msg "build: full + legacy dispatch in block_cipher"
4027
4028 common_block_cipher_dispatch 0
4029
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004030 make
4031
4032 msg "test: full + legacy dispatch in block_cipher"
4033 make test
4034}
4035
Gilles Peskine36dea152023-07-20 22:19:45 +02004036component_test_aead_chachapoly_disabled() {
4037 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004038 scripts/config.py full
4039 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004040 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004041 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004042
Gilles Peskine36dea152023-07-20 22:19:45 +02004043 msg "test: full minus CHACHAPOLY"
4044 make test
4045}
4046
4047component_test_aead_only_ccm() {
4048 msg "build: full minus CHACHAPOLY and GCM"
4049 scripts/config.py full
4050 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4051 scripts/config.py unset MBEDTLS_GCM_C
4052 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4053 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004054 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004055
4056 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004057 make test
4058}
4059
Ronald Crone501d0e2023-07-10 08:31:19 +02004060component_test_ccm_aes_sha256() {
4061 msg "build: CCM + AES + SHA256 configuration"
4062
Ronald Cron7612d8c2023-07-20 10:03:54 +02004063 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004064 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004065
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004066 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004067
4068 msg "test: CCM + AES + SHA256 configuration"
4069 make test
4070}
4071
Dave Rodgman904c5892023-06-28 17:36:02 +01004072support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004073 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004074}
4075
Dave Rodgman904c5892023-06-28 17:36:02 +01004076component_build_tfm_armcc() {
4077 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004078 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004079
Dave Rodgman88651c42023-06-29 12:35:51 +01004080 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004081 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 +01004082}
4083
4084component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004085 # Check that the TF-M configuration can build cleanly with various
4086 # warning flags enabled. We don't build or run tests, since the
4087 # TF-M configuration needs a TF-M platform. A tweaked version of
4088 # the configuration that works on mainstream platforms is in
4089 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004090 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004091
Dave Rodgman88651c42023-06-29 12:35:51 +01004092 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004093 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 +01004094
Dave Rodgman904c5892023-06-28 17:36:02 +01004095 msg "build: TF-M config, gcc native build"
4096 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004097 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 +01004098}
4099
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004100# Test that the given .o file builds with all (valid) combinations of the given options.
4101#
4102# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4103#
4104# The validator function is the name of a function to validate the combination of options.
4105# It may be "" if all combinations are valid.
4106# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004107# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004108build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004109 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004110 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004111 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004112 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004113 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004114
Dave Rodgman42436102023-10-03 15:47:05 +01004115 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004116 for opt in "${options[@]}"; do
4117 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004118 done
4119
Ronald Cron709bbf02024-07-03 07:59:30 +02004120 # enter the library directory
4121 cd library
Dave Rodgman42436102023-10-03 15:47:05 +01004122
Dave Rodgman920343a2023-10-01 18:41:09 +01004123 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004124 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 +01004125
Dave Rodgman42436102023-10-03 15:47:05 +01004126 # Extract the command generated by the Makefile to build the target file.
4127 # This ensures that we have any include paths, macro definitions, etc
4128 # that may be applied by make.
4129 # 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 +01004130 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004131
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004132 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004133 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004134
Dave Rodgman28e38d82023-10-04 11:50:30 +01004135 len=${#options[@]}
Ronald Cron709bbf02024-07-03 07:59:30 +02004136 source_file=../${file%.o}.c
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004137
4138 targets=0
4139 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004140
Dave Rodgman28e38d82023-10-04 11:50:30 +01004141 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004142 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004143 # each bit of $i is used to determine if options[i] will be set or not
4144 target="t"
4145 clang_args=""
4146 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004147 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004148 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004149 clang_args="${clang_args} ${opt}"
4150 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004151 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004152 done
4153
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004154 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004155 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004156 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004157 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004158
Dave Rodgman28e38d82023-10-04 11:50:30 +01004159 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004160 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004161 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004162 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004163
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004164 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004165
Dave Rodgman920343a2023-10-01 18:41:09 +01004166 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004167 make -s -f ${makefile} build_test_config_combos
4168 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004169
4170 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004171 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004172}
4173
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004174validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004175 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004176 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4177 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004178 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004179 fi
4180 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004181 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004182}
4183
4184component_build_aes_variations() {
4185 # 18s - around 90ms per clang invocation on M1 Pro
4186 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004187 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004188 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004189
Yanray Wangbc29aef2023-11-06 11:08:17 +08004190 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004191 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004192
Ronald Cron709bbf02024-07-03 07:59:30 +02004193 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004194 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4195 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004196 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004197 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004198
4199 cd "$MBEDTLS_ROOT_DIR"
4200 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4201
Yanray Wang42be1ba2023-11-23 14:28:47 +08004202 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004203 # manually set or unset those configurations to check
4204 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004205 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4206 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4207 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4208 scripts/config.py unset MBEDTLS_DES_C
4209 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron709bbf02024-07-03 07:59:30 +02004210 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004211 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4212 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004213 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004214 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004215}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004216
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004217component_test_no_platform () {
4218 # Full configuration build, without platform support, file IO and net sockets.
4219 # This should catch missing mbedtls_printf definitions, and by disabling file
4220 # IO, it should catch missing '#include <stdio.h>'
4221 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004222 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004223 scripts/config.py unset MBEDTLS_PLATFORM_C
4224 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004225 scripts/config.py unset MBEDTLS_FS_IO
4226 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004227 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004228 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004229 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004230 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004231 # to re-enable platform integration features otherwise disabled in C99 builds
4232 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004233 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004234}
Gilles Peskine7c652162017-12-11 00:01:40 +01004235
4236component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004237 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004238 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4239 scripts/config.py full
4240 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004241 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4242 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4243 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4244 make
4245}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004246
Gilles Peskine8f073122018-11-27 15:58:47 +01004247component_build_no_ssl_srv () {
4248 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004249 scripts/config.py full
4250 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004251 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004252}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004253
Gilles Peskine8f073122018-11-27 15:58:47 +01004254component_build_no_ssl_cli () {
4255 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004256 scripts/config.py full
4257 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004258 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004259}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004260
Gilles Peskine8f073122018-11-27 15:58:47 +01004261component_build_no_sockets () {
4262 # Note, C99 compliance can also be tested with the sockets support disabled,
4263 # as that requires a POSIX platform (which isn't the same as C99).
4264 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004265 scripts/config.py full
4266 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4267 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4268 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4269}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004270
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004271component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004272 msg "build: default config with memory buffer allocator and backtrace enabled"
4273 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4274 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4275 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004276 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004277 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004278 make
4279
4280 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4281 make test
4282}
4283
4284component_test_memory_buffer_allocator () {
4285 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004286 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4287 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004288 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004289 make
4290
4291 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4292 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004293
4294 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4295 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004296 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004297}
4298
Gilles Peskine8f073122018-11-27 15:58:47 +01004299component_test_no_max_fragment_length () {
4300 # Run max fragment length tests with MFL disabled
4301 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004302 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004303 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004304 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004305
Gilles Peskine8f073122018-11-27 15:58:47 +01004306 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004307 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004308}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004309
Hanno Becker545ced42019-02-19 11:10:48 +00004310component_test_asan_remove_peer_certificate () {
4311 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004312 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004313 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004314 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004315 make
4316
4317 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4318 make test
4319
4320 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004321 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004322
4323 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004324 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004325
4326 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004327 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004328}
4329
Gilles Peskine8f073122018-11-27 15:58:47 +01004330component_test_no_max_fragment_length_small_ssl_out_content_len () {
4331 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004332 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4333 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4334 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004335 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004336 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004337
Gilles Peskine8f073122018-11-27 15:58:47 +01004338 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004339 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004340
4341 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004342 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004343}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004344
Darryl Greenaad82f92019-12-02 10:53:11 +00004345component_test_variable_ssl_in_out_buffer_len () {
4346 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4347 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004348 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004349 make
4350
4351 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4352 make test
4353
4354 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004355 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004356
4357 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004358 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004359}
4360
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004361component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004362 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004363 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004364
Dave Rodgman17127e92023-12-14 16:42:48 +00004365 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004366 make
4367
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004368 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004369 make test
4370
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004371 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004372 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004373
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004374 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004375 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004376}
4377
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004378component_test_ssl_alloc_buffer_and_mfl () {
4379 msg "build: default config with memory buffer allocator and MFL extension"
4380 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4381 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4382 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4383 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4384 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004385 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004386 make
4387
4388 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4389 make test
4390
4391 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 +02004392 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004393}
4394
Gilles Peskine636c26a2020-03-04 20:46:15 +01004395component_test_when_no_ciphersuites_have_mac () {
4396 msg "build: when no ciphersuites have MAC"
Ronald Cron0417a2c2024-05-24 14:22:11 +02004397 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4398 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4399 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4400 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4401 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
4402
Gilles Peskine636c26a2020-03-04 20:46:15 +01004403 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004404 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004405 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron0417a2c2024-05-24 14:22:11 +02004406
Gilles Peskine636c26a2020-03-04 20:46:15 +01004407 make
4408
Ronald Croncd33cd62024-05-27 08:14:27 +02004409 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004410 make test
4411
Ronald Croncd33cd62024-05-27 08:14:27 +02004412 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004413 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004414}
4415
Raoul Strackxa4e86142020-06-15 17:03:13 +02004416component_test_no_date_time () {
4417 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4418 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004419 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004420 make
4421
4422 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4423 make test
4424}
4425
Gilles Peskine8f073122018-11-27 15:58:47 +01004426component_test_platform_calloc_macro () {
4427 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004428 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4429 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4430 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004431 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004432 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004433
Gilles Peskine8f073122018-11-27 15:58:47 +01004434 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4435 make test
4436}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004437
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004438component_test_malloc_0_null () {
4439 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004440 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004441 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 +02004442
4443 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4444 make test
4445
4446 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4447 # Just the calloc selftest. "make test" ran the others as part of the
4448 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004449 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004450
4451 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4452 # Run a subset of the tests. The choice is a balance between coverage
4453 # and time (including time indirectly wasted due to flaky tests).
4454 # The current choice is to skip tests whose description includes
4455 # "proxy", which is an approximation of skipping tests that use the
4456 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004457 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004458}
4459
Dave Rodgman6a08b682023-06-19 11:51:33 +01004460support_test_aesni() {
4461 # Check that gcc targets x86_64 (we can build AESNI), and check for
4462 # AESNI support on the host (we can run AESNI).
4463 #
4464 # The name of this function is possibly slightly misleading, but needs to align
4465 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004466 #
4467 # In principle 32-bit x86 can support AESNI, but our implementation does not
4468 # support 32-bit x86, so we check for x86-64.
4469 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004470 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4471 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004472 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004473}
4474
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004475component_test_aesni () { # ~ 60s
4476 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4477 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4478 #
4479 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4480 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4481 # exercise the plain C impl).
4482
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004483 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004484 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004485 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004486 scripts/config.py set MBEDTLS_HAVE_ASM
4487
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004488 # test the intrinsics implementation
4489 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004490 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004491 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004492 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004493 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004494
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004495 # test the asm implementation
4496 msg "AES tests, test assembly"
4497 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004498 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004499 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004500 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004501
4502 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004503 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004504 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004505 msg "AES tests, plain C"
4506 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004507 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004508 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004509 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004510 not grep -q "AES note: using AESNI" ./programs/test/selftest
4511 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004512
4513 # test the intrinsics implementation
4514 scripts/config.py set MBEDTLS_AESNI_C
4515 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4516 msg "AES tests, test AESNI only"
4517 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004518 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004519 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4520 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004521 grep -q "AES note: using AESNI" ./programs/test/selftest
4522 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004523}
4524
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004525component_test_sha3_variations() {
4526 msg "sha3 loop unroll variations"
4527
4528 # define minimal config sufficient to test SHA3
4529 cat > include/mbedtls/mbedtls_config.h << END
4530 #define MBEDTLS_SELF_TEST
4531 #define MBEDTLS_SHA3_C
4532END
4533
4534 msg "all loops unrolled"
4535 make clean
Ronald Cron635a2be2024-07-12 14:30:16 +02004536 make -C tests ../tf-psa-crypto/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"
4537 ./tf-psa-crypto/tests/test_suite_shax
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004538
4539 msg "all loops rolled up"
4540 make clean
Ronald Cron635a2be2024-07-12 14:30:16 +02004541 make -C tests ../tf-psa-crypto/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"
4542 ./tf-psa-crypto/tests/test_suite_shax
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004543}
4544
Jerry Yub6d39c22023-08-16 15:11:48 +08004545support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004546 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004547}
4548
4549component_test_aesni_m32 () { # ~ 60s
4550 # This tests are duplicated from component_test_aesni for i386 target
4551 #
4552 # AESNI intrinsic code supports i386 and assembly code does not support it.
4553
4554 msg "build: default config with different AES implementations"
4555 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004556 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4557 scripts/config.py set MBEDTLS_HAVE_ASM
4558
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004559 # test the intrinsics implementation with gcc
4560 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004561 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004562 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004563 # check that we built intrinsics - this should be used by default when supported by the compiler
4564 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4565 grep -q "AES note: using AESNI" ./programs/test/selftest
4566 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004567 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4568
4569 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004570 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4571 msg "AES tests, test AESNI only"
4572 make clean
4573 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4574 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4575 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4576 grep -q "AES note: using AESNI" ./programs/test/selftest
4577 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004578 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4579}
4580
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004581support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004582 # clang >= 4 is required to build with target attributes
4583 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004584}
4585
4586component_test_aesni_m32_clang() {
4587
4588 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004589 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4590 scripts/config.py set MBEDTLS_HAVE_ASM
4591
4592 # test the intrinsics implementation with clang
4593 msg "AES tests, test intrinsics (clang)"
4594 make clean
4595 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4596 # check that we built intrinsics - this should be used by default when supported by the compiler
4597 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4598 grep -q "AES note: using AESNI" ./programs/test/selftest
4599 grep -q "AES note: built-in implementation." ./programs/test/selftest
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004600 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4601}
4602
Jerry Yu193cbc02023-08-03 17:06:29 +08004603# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4604component_build_aes_aesce_armcc () {
4605 msg "Build: AESCE test on arm64 platform without plain C."
4606 scripts/config.py baremetal
4607
4608 # armc[56] don't support SHA-512 intrinsics
4609 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4610
4611 # Stop armclang warning about feature detection for A64_CRYPTO.
4612 # With this enabled, the library does build correctly under armclang,
4613 # but in baremetal builds (as tested here), feature detection is
4614 # unavailable, and the user is notified via a #warning. So enabling
4615 # this feature would prevent us from building with -Werror on
4616 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004617 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004618 scripts/config.py set MBEDTLS_HAVE_ASM
4619
4620 msg "AESCE, build with default configuration."
4621 scripts/config.py set MBEDTLS_AESCE_C
4622 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4623 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4624
4625 msg "AESCE, build AESCE only"
4626 scripts/config.py set MBEDTLS_AESCE_C
4627 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4628 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4629}
4630
Dave Rodgman0c584032023-10-08 12:26:54 +01004631support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004632 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004633 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004634}
4635
4636component_build_aes_armce () {
4637 # Test variations of AES with Armv8 crypto extensions
4638 scripts/config.py set MBEDTLS_AESCE_C
4639 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4640
4641 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004642 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 +01004643
4644 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
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-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004646
4647 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004648 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 +01004649
Dave Rodgman5e419372023-10-23 15:30:20 +01004650 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004651
Dave Rodgman5e419372023-10-23 15:30:20 +01004652 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004653 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 +01004654
Dave Rodgman5e419372023-10-23 15:30:20 +01004655 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004656 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 +01004657
Dave Rodgman5e419372023-10-23 15:30:20 +01004658 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004659 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 +01004660
4661 # test for presence of AES instructions
4662 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4663 msg "clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004664 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4665 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004666 msg "clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004667 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4668 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004669 msg "clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004670 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4671 grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004672
4673 # test for absence of AES instructions
4674 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4675 scripts/config.py unset MBEDTLS_AESCE_C
4676 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004677 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4678 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004679 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004680 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4681 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004682 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004683 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4684 not grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004685}
4686
Dave Rodgman9ed18532023-10-05 00:06:47 +01004687support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004688 # clang >= 4 is required to build with SHA extensions
4689 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004690}
4691
Dave Rodgmand9e80832023-10-04 17:17:46 +01004692component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004693 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004694
4695
4696 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004697 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004698 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004699 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 +01004700 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004701 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 +01004702 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004703
Dave Rodgmand9e80832023-10-04 17:17:46 +01004704
Dave Rodgman94a634d2023-10-10 12:59:29 +01004705 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004706 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004707 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
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-a32+crypto -mthumb"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004709 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004710
Dave Rodgman5b89c552023-10-10 14:59:02 +01004711 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004712 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004713 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 +01004714 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004715
Dave Rodgmancd654002023-10-05 09:40:07 +01004716
Dave Rodgman94a634d2023-10-10 12:59:29 +01004717 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004718 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004719 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004720 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 +01004721 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004722 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 +01004723 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004724
Dave Rodgmancd654002023-10-05 09:40:07 +01004725
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004726 # examine the disassembly for presence of SHA instructions
4727 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4728 scripts/config.py set ${opt}
4729 msg "${opt} clang, test A32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004730 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4731 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004732
4733 msg "${opt} clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004734 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4735 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004736
4737 msg "${opt} clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004738 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4739 grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004740 scripts/config.py unset ${opt}
4741 done
4742
4743
4744 # examine the disassembly for absence of SHA instructions
4745 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004746 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4747 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004748
4749 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004750 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4751 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004752
4753 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004754 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4755 not grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004756}
4757
Jerry Yu193cbc02023-08-03 17:06:29 +08004758support_build_aes_aesce_armcc () {
4759 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004760}
4761
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004762component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004763 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004764 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004765
Dave Rodgmand8d64512023-12-19 12:20:21 +00004766 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004767
4768 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4769 make test
4770}
4771
4772component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4773 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4774 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004775 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004776
Hanno Becker83ebf782017-07-07 12:29:15 +01004777 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004778
4779 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004780 make test
4781}
Gilles Peskine8f073122018-11-27 15:58:47 +01004782
Hanno Becker83ebf782017-07-07 12:29:15 +01004783component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004784 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4785 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004786 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004787 scripts/config.py unset MBEDTLS_AESCE_C
4788
Dave Rodgmand8d64512023-12-19 12:20:21 +00004789 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004790
4791 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004792 make test
4793
4794 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4795 programs/test/selftest
4796}
4797
Matthias Schulz0767fda2024-02-07 10:46:28 +01004798component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004799 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4800 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004801 scripts/config.py unset MBEDTLS_AESNI_C
4802 scripts/config.py unset MBEDTLS_AESCE_C
4803
4804 make CFLAGS='-O2 -Werror -Wall -Wextra'
4805
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004806 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004807 make test
4808}
4809
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004810component_test_aes_fewer_tables () {
4811 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004812 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004813 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004814
Gilles Peskine7c652162017-12-11 00:01:40 +01004815 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004816 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004817}
4818
4819component_test_aes_rom_tables () {
4820 msg "build: default config with AES_ROM_TABLES enabled"
4821 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004822 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004823
4824 msg "test: AES_ROM_TABLES"
4825 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004826}
4827
Gilles Peskine14c3c062018-01-29 21:25:12 +01004828component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004829 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4830 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4831 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004832 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004833
Gilles Peskine8f073122018-11-27 15:58:47 +01004834 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4835 make test
4836}
4837
Yanray Wang49cd4b52023-11-10 11:58:37 +08004838# helper for common_block_cipher_no_decrypt() which:
4839# - enable/disable the list of config options passed from -s/-u respectively.
4840# - build
4841# - test for tests_suite_xxx
4842# - selftest
4843#
4844# Usage: helper_block_cipher_no_decrypt_build_test
4845# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4846# Options: -s set_opts the list of config options to enable
4847# -u unset_opts the list of config options to disable
4848# -c cflags the list of options passed to CFLAGS
4849# -l ldflags the list of options passed to LDFLAGS
4850helper_block_cipher_no_decrypt_build_test () {
4851 while [ $# -gt 0 ]; do
4852 case "$1" in
4853 -s)
4854 shift; local set_opts="$1";;
4855 -u)
4856 shift; local unset_opts="$1";;
4857 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004858 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004859 -l)
4860 shift; local ldflags="$1";;
4861 esac
4862 shift
4863 done
4864 set_opts="${set_opts:-}"
4865 unset_opts="${unset_opts:-}"
4866 cflags="${cflags:-}"
4867 ldflags="${ldflags:-}"
4868
Yanray Wangb2d6e522023-11-13 16:57:47 +08004869 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4870 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004871
4872 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4873 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004874 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004875
4876 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004877 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4878 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4879 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004880 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004881 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004882 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
Ronald Cron709bbf02024-07-03 07:59:30 +02004883 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004884
4885 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4886 make test
4887
4888 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4889 programs/test/selftest
4890}
4891
4892# This is a common configuration function used in:
4893# - component_test_block_cipher_no_decrypt_aesni_legacy()
4894# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4895# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4896# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4897# on x86.
4898common_block_cipher_no_decrypt () {
4899 # test AESNI intrinsics
4900 helper_block_cipher_no_decrypt_build_test \
4901 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004902 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004903
4904 # test AESNI assembly
4905 helper_block_cipher_no_decrypt_build_test \
4906 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004907 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004908
4909 # test AES C implementation
4910 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004911 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004912
4913 # test AESNI intrinsics for i386 target
4914 helper_block_cipher_no_decrypt_build_test \
4915 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004916 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004917 -l "-m32"
4918}
4919
Yanray Wang3ae11992023-11-13 17:32:09 +08004920# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4921# usage: 0: no PSA crypto configuration
4922# 1: use PSA crypto configuration
4923config_block_cipher_no_decrypt () {
4924 use_psa=$1
4925
Yanray Wang66111392023-10-31 18:54:54 +08004926 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004927 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4928 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004929 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004930 scripts/config.py unset MBEDTLS_NIST_KW_C
4931
Yanray Wang3ae11992023-11-13 17:32:09 +08004932 if [ "$use_psa" -eq 1 ]; then
4933 # Enable support for cryptographic mechanisms through the PSA API.
4934 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4935 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4936 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4937 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4938 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4939 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4940 fi
4941}
4942
4943component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004944 # This consistently causes an llvm crash on clang 3.8, so use gcc
4945 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004946 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004947 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004948}
4949
Yanray Wangf1496402023-11-01 18:55:13 +08004950component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004951 # This consistently causes an llvm crash on clang 3.8, so use gcc
4952 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004953 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004954 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004955}
4956
Yanray Wang66111392023-10-31 18:54:54 +08004957support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004958 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08004959}
4960
Yanray Wang66111392023-10-31 18:54:54 +08004961component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08004962 scripts/config.py baremetal
4963
4964 # armc[56] don't support SHA-512 intrinsics
4965 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4966
4967 # Stop armclang warning about feature detection for A64_CRYPTO.
4968 # With this enabled, the library does build correctly under armclang,
4969 # but in baremetal builds (as tested here), feature detection is
4970 # unavailable, and the user is notified via a #warning. So enabling
4971 # this feature would prevent us from building with -Werror on
4972 # armclang. Tracked in #7198.
4973 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4974 scripts/config.py set MBEDTLS_HAVE_ASM
4975
Yanray Wang3ae11992023-11-13 17:32:09 +08004976 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08004977
4978 # test AESCE baremetal build
4979 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08004980 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08004981 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08004982
Yanray Wangef1b04d2023-09-08 11:09:26 +08004983 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004984 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4985 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4986 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wangef1b04d2023-09-08 11:09:26 +08004987 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004988 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004989 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Ronald Cron709bbf02024-07-03 07:59:30 +02004990 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
4991 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08004992}
4993
Gilles Peskine592f5912019-10-07 18:49:32 +02004994component_test_ctr_drbg_aes_256_sha_256 () {
4995 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4996 scripts/config.py full
4997 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4998 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004999 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005000 make
5001
5002 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5003 make test
5004}
5005
5006component_test_ctr_drbg_aes_128_sha_512 () {
5007 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005008 scripts/config.py full
5009 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5010 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005011 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005012 make
5013
5014 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5015 make test
5016}
5017
5018component_test_ctr_drbg_aes_128_sha_256 () {
5019 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005020 scripts/config.py full
5021 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5022 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5023 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005024 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005025 make
5026
5027 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5028 make test
5029}
5030
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005031component_test_se_default () {
5032 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005033 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005034 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005035
5036 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5037 make test
5038}
5039
Steven Cooremand57203d2020-07-16 20:28:59 +02005040component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005041 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005042 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005043 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005044 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5045 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005046 loc_cflags="${loc_cflags} -I../tests/include -O2"
5047
Gilles Peskine21570cf2023-12-22 11:49:50 +01005048 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005049
Gilles Peskine1997f302023-07-26 18:45:20 +02005050 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005051 make test
5052}
5053
Gilles Peskine8f073122018-11-27 15:58:47 +01005054component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005055 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005056 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005057 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005058 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005059}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005060
Gilles Peskinecf740502019-07-03 20:43:05 +02005061component_test_cmake_shared () {
5062 msg "build/test: cmake shared" # ~ 2min
5063 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5064 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005065 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005066 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005067 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005068}
5069
Gilles Peskineec10bf12019-09-20 19:56:06 +02005070test_build_opt () {
5071 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005072 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005073 for opt in "$@"; do
5074 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005075 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005076 # We're confident enough in compilers to not run _all_ the tests,
5077 # but at least run the unit tests. In particular, runs with
5078 # optimizations use inline assembly whereas runs with -O0
5079 # skip inline assembly.
5080 make test # ~30s
5081 make clean
5082 done
5083}
5084
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005085# For FreeBSD we invoke the function by name so this condition is added
5086# to disable the existing test_clang_opt function for linux.
5087if [[ $(uname) != "Linux" ]]; then
5088 component_test_clang_opt () {
5089 scripts/config.py full
5090 test_build_opt 'full config' clang -O0 -Os -O2
5091 }
5092fi
5093
5094component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005095 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005096 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005097}
5098support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005099 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005100}
5101
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005102component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005103 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005104 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005105}
5106support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005107 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005108}
5109
5110component_test_gcc_latest_opt () {
5111 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005112 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005113}
5114support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005115 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005116}
5117
5118component_test_gcc_earliest_opt () {
5119 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005120 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005121}
5122support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005123 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005124}
5125
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005126component_build_mbedtls_config_file () {
5127 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005128 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005129 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005130 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005131 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005132 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5133 make clean
5134
5135 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5136 # In the user config, disable one feature (for simplicity, pick a feature
5137 # that nothing else depends on).
5138 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005139 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005140 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5141
5142 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005143}
5144
Gilles Peskine7d904e72022-04-07 21:59:14 +02005145component_build_psa_config_file () {
5146 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5147 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5148 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5149 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5150 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005151 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005152 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5153 make clean
5154
5155 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005156 # In the user config, disable one feature and its dependencies, which will
5157 # reflect on the mbedtls configuration so we can query it with
5158 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005159 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005160 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005161 scripts/config.py unset MBEDTLS_CMAC_C
5162 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5163 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5164
5165 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005166}
5167
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005168component_build_psa_alt_headers () {
5169 msg "build: make with PSA alt headers" # ~20s
5170
5171 # Generate alternative versions of the substitutable headers with the
5172 # same content except different include guards.
5173 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5174
5175 # Build the library and some programs.
5176 # Don't build the fuzzers to avoid having to go through hoops to set
5177 # a correct include path for programs/fuzz/Makefile.
5178 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
5179 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\"'"
5180
5181 # Check that we're getting the alternative include guards and not the
5182 # original include guards.
5183 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5184 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5185 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5186 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5187}
5188
Dave Rodgman852de3c2023-12-14 14:46:45 +00005189component_test_m32_no_asm () {
5190 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005191 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005192 #
5193 # Note that we require gcc, because clang Asan builds fail to link for
5194 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005195 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005196 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005197 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005198 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005199 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005200
Dave Rodgman852de3c2023-12-14 14:46:45 +00005201 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005202 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005203}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005204support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005205 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005206 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005207 *) false;;
5208 esac
5209}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005210
Gilles Peskineff0aee02021-10-05 09:36:03 +02005211component_test_m32_o2 () {
5212 # Build with optimization, to use the i386 specific inline assembly
5213 # and go faster for tests.
5214 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005215 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005216 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005217 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005218
Gilles Peskineff0aee02021-10-05 09:36:03 +02005219 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005220 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005221
Gilles Peskineff0aee02021-10-05 09:36:03 +02005222 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005223 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005224}
Gilles Peskinecf522222021-10-07 19:25:29 +02005225support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005226 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005227}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005228
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005229component_test_m32_everest () {
5230 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005231 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005232 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005233 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005234
5235 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5236 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005237
5238 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005239 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005240
5241 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5242 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005243 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005244}
5245support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005246 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005247}
5248
Gilles Peskine8f073122018-11-27 15:58:47 +01005249component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005250 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005251 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005252 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005253
5254 msg "test: 64-bit ILP32, make, gcc"
5255 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005256}
Gilles Peskine878cf602019-01-06 20:50:38 +00005257support_test_mx32 () {
5258 case $(uname -m) in
5259 amd64|x86_64) true;;
5260 *) false;;
5261 esac
5262}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005263
Peter Kolbus60c6da22018-12-27 06:59:04 -06005264component_test_min_mpi_window_size () {
5265 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005266 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005267 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005268 make
5269
5270 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5271 make test
5272}
5273
Gilles Peskine8f073122018-11-27 15:58:47 +01005274component_test_have_int32 () {
5275 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005276 scripts/config.py unset MBEDTLS_HAVE_ASM
5277 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005278 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005279 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005280
Gilles Peskine8f073122018-11-27 15:58:47 +01005281 msg "test: gcc, force 32-bit bignum limbs"
5282 make test
5283}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005284
Gilles Peskine8f073122018-11-27 15:58:47 +01005285component_test_have_int64 () {
5286 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005287 scripts/config.py unset MBEDTLS_HAVE_ASM
5288 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005289 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005290 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005291
Gilles Peskine8f073122018-11-27 15:58:47 +01005292 msg "test: gcc, force 64-bit bignum limbs"
5293 make test
5294}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005295
Gabor Mezeie256cc12023-07-26 17:28:48 +02005296component_test_have_int32_cmake_new_bignum () {
5297 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5298 scripts/config.py unset MBEDTLS_HAVE_ASM
5299 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005300 scripts/config.py unset MBEDTLS_AESCE_C
5301 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005302 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005303 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005304
5305 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5306 make test
5307}
5308
Gilles Peskine8f073122018-11-27 15:58:47 +01005309component_test_no_udbl_division () {
5310 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005311 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005312 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005313 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005314
Gilles Peskine8f073122018-11-27 15:58:47 +01005315 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5316 make test
5317}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005318
Gilles Peskine8f073122018-11-27 15:58:47 +01005319component_test_no_64bit_multiplication () {
5320 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005321 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005322 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005323 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005324
Gilles Peskine8f073122018-11-27 15:58:47 +01005325 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5326 make test
5327}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005328
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005329component_test_no_strings () {
5330 msg "build: no strings" # ~10s
5331 scripts/config.py full
5332 # Disable options that activate a large amount of string constants.
5333 scripts/config.py unset MBEDTLS_DEBUG_C
5334 scripts/config.py unset MBEDTLS_ERROR_C
5335 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5336 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005337 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005338
5339 msg "test: no strings" # ~ 10s
5340 make test
5341}
5342
Hanno Beckerc5722d12020-10-09 11:10:42 +01005343component_test_no_x509_info () {
5344 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5345 scripts/config.pl full
5346 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5347 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005348 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005349
5350 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5351 make test
5352
5353 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005354 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005355}
5356
Gilles Peskine8f073122018-11-27 15:58:47 +01005357component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005358 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005359 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005360 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 +02005361
Gilles Peskinee36fe812021-09-01 20:00:33 +02005362 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005363 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005364 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005365 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005366}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005367
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005368component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005369 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005370 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005371 # Build for a target platform that's close to what Debian uses
5372 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005373 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005374 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005375 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005376 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'
5377
Gilles Peskinee36fe812021-09-01 20:00:33 +02005378 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005379 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005380 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005381 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005382}
5383support_build_arm_linux_gnueabi_gcc_arm5vte () {
5384 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5385}
5386
5387component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005388 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005389 scripts/config.py baremetal
5390 # This is an imperfect substitute for
5391 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005392 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005393 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 +02005394
Gilles Peskinee36fe812021-09-01 20:00:33 +02005395 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005396 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005397 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005398 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005399}
5400
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005401component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005402 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5403 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005404 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 +02005405
Gilles Peskinee36fe812021-09-01 20:00:33 +02005406 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005407 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005408 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005409 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005410 for lib in library/*.a; do
5411 echo "$lib:"
5412 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5413 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005414}
5415
Gilles Peskine8f073122018-11-27 15:58:47 +01005416component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005417 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005418 scripts/config.py baremetal
5419 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005420 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 +01005421 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005422 not grep __aeabi_uldiv library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005423 not grep __aeabi_uldiv ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005424 not grep __aeabi_uldiv ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005425}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005426
Gilles Peskine8f073122018-11-27 15:58:47 +01005427component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005428 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005429 scripts/config.py baremetal
5430 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005431 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 +01005432 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005433 not grep __aeabi_lmul library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005434 not grep __aeabi_lmul ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005435 not grep __aeabi_lmul ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005436}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005437
Dave Rodgman8c315f22023-06-02 10:26:24 -04005438component_build_arm_clang_thumb () {
5439 # ~ 30s
5440
5441 scripts/config.py baremetal
5442
5443 msg "build: clang thumb 2, make"
5444 make clean
5445 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5446
5447 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5448 msg "build: clang thumb 1 -O0, make"
5449 make clean
5450 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5451
5452 msg "build: clang thumb 1 -Os, make"
5453 make clean
5454 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5455}
5456
Gilles Peskine8f073122018-11-27 15:58:47 +01005457component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005458 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005459 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005460 # armc[56] don't support SHA-512 intrinsics
5461 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005462
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005463 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5464 scripts/config.py unset MBEDTLS_AESCE_C
5465
Dave Rodgman0fddf822023-03-02 15:32:12 +00005466 # Stop armclang warning about feature detection for A64_CRYPTO.
5467 # With this enabled, the library does build correctly under armclang,
5468 # but in baremetal builds (as tested here), feature detection is
5469 # unavailable, and the user is notified via a #warning. So enabling
5470 # this feature would prevent us from building with -Werror on
5471 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005472 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005473
Hanno Beckerf0762e92022-07-15 12:08:19 +01005474 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005475
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005476 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005477
5478 msg "size: ARM Compiler 5"
5479 "$ARMC5_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005480 "$ARMC5_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005481 "$ARMC5_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine18487f62020-04-30 23:11:54 +02005482
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005483 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005484
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005485 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005486 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005487
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005488 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005489 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5490
5491 # ARM Compiler 6 - Target ARMv7-M+DSP
5492 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005493
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005494 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005495 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005496
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005497 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005498 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005499
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005500 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5501 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5502
Dave Rodgman99318e62023-05-24 12:27:42 +01005503 # ARM Compiler 6 - Target Cortex-M0
5504 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005505
5506 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5507 #
5508 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5509 # that we have in our CI
5510 scripts/config.py set MBEDTLS_AESCE_C
5511 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005512}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005513
Pengyu Lvdf070032023-02-24 16:03:31 +08005514support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005515 armc5_cc="$ARMC5_BIN_DIR/armcc"
5516 armc6_cc="$ARMC6_BIN_DIR/armclang"
5517 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005518}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005519
Ronald Crond2cb7f42024-03-18 12:49:18 +01005520component_test_tls12_only () {
5521 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5522 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5523 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5524 make
5525
5526 msg "test: main suites (inc. selftests) (ASan build)"
5527 make test
5528
5529 msg "test: ssl-opt.sh (ASan build)"
5530 tests/ssl-opt.sh
5531
5532 msg "test: compat.sh (ASan build)"
5533 tests/compat.sh
5534}
5535
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005536component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005537 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005538 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005539 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005540 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5541
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005542 msg "test: TLS 1.3 only, all key exchange modes enabled"
5543 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005544
Ronald Cronc3f43b62022-10-17 17:35:32 +02005545 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5546 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005547}
5548
Ronald Cronc3f43b62022-10-17 17:35:32 +02005549component_test_tls13_only_psk () {
5550 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5551 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5552 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5553 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005554 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005555 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5556 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5557 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5558 scripts/config.py unset MBEDTLS_ECDSA_C
5559 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005560 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005561 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005562 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5563
Ronald Cronc3f43b62022-10-17 17:35:32 +02005564 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5565 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005566
Ronald Cronc3f43b62022-10-17 17:35:32 +02005567 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5568 tests/ssl-opt.sh
5569}
5570
5571component_test_tls13_only_ephemeral () {
5572 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5573 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5574 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005575 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005576 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5577
5578 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5579 cd tests; ./test_suite_ssl; cd ..
5580
5581 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5582 tests/ssl-opt.sh
5583}
5584
Przemek Stekiela01c2422023-06-13 10:46:48 +02005585component_test_tls13_only_ephemeral_ffdh () {
5586 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5587 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5588 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5589 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005590 scripts/config.py unset MBEDTLS_ECDH_C
5591
Przemek Stekiela01c2422023-06-13 10:46:48 +02005592 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5593
5594 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5595 cd tests; ./test_suite_ssl; cd ..
5596
5597 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5598 tests/ssl-opt.sh
5599}
5600
Ronald Cronc3f43b62022-10-17 17:35:32 +02005601component_test_tls13_only_psk_ephemeral () {
5602 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5603 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5604 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5605 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5606 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5607 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5608 scripts/config.py unset MBEDTLS_ECDSA_C
5609 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005610 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005611 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005612 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5613
5614 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5615 cd tests; ./test_suite_ssl; cd ..
5616
5617 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5618 tests/ssl-opt.sh
5619}
5620
Przemek Stekiela01c2422023-06-13 10:46:48 +02005621component_test_tls13_only_psk_ephemeral_ffdh () {
5622 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5623 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5624 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5625 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5626 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5627 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5628 scripts/config.py unset MBEDTLS_ECDSA_C
5629 scripts/config.py unset MBEDTLS_PKCS1_V21
5630 scripts/config.py unset MBEDTLS_PKCS7_C
5631 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005632 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005633 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5634
5635 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5636 cd tests; ./test_suite_ssl; cd ..
5637
5638 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5639 tests/ssl-opt.sh
5640}
5641
Ronald Cronc3f43b62022-10-17 17:35:32 +02005642component_test_tls13_only_psk_all () {
5643 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5644 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5645 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5646 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5647 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5648 scripts/config.py unset MBEDTLS_ECDSA_C
5649 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005650 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005651 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005652 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5653
5654 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5655 cd tests; ./test_suite_ssl; cd ..
5656
5657 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5658 tests/ssl-opt.sh
5659}
5660
5661component_test_tls13_only_ephemeral_all () {
5662 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5663 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005664 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005665 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5666
5667 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5668 cd tests; ./test_suite_ssl; cd ..
5669
5670 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5671 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005672}
5673
Ronald Cron46ac0652024-03-18 12:39:04 +01005674component_test_tls13_no_padding () {
5675 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005676 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005677 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005678 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005679 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005680 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005681 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005682 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005683 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005684}
5685
Ronald Cron6f135e12021-12-08 16:57:54 +01005686component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005687 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005688 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005689 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005690 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005691 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005692 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005693 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005694 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005695 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005696}
5697
Ronald Crondd96c0a2024-04-02 12:34:24 +02005698component_test_full_minus_session_tickets() {
5699 msg "build: full config without session tickets"
5700 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005701 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005702 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005703 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5704 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005705 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005706 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005707 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005708 tests/ssl-opt.sh
5709}
5710
Gilles Peskine8f073122018-11-27 15:58:47 +01005711component_build_mingw () {
5712 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005713 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 +00005714
Gilles Peskine8f073122018-11-27 15:58:47 +01005715 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005716 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 +01005717 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005718
Gilles Peskine8f073122018-11-27 15:58:47 +01005719 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005720 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
5721 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 +01005722 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005723
Pengyu Lv158eead2023-10-19 11:27:05 +08005724 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005725 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005726 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 +01005727 make WINDOWS_BUILD=1 clean
5728}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005729support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005730 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5731 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005732 *) true;;
5733 esac
5734}
Simon Butcher91aef332016-11-17 09:20:50 +00005735
Gilles Peskine8f073122018-11-27 15:58:47 +01005736component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005737 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005738 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005739 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5740 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005741
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005742 msg "test: main suites (MSan)" # ~ 10s
5743 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005744
Gilles Peskine6848d172023-11-02 19:58:03 +01005745 msg "test: metatests (MSan)"
5746 tests/scripts/run-metatests.sh any msan
5747
Gilles Peskine82b27272019-06-14 18:27:03 +02005748 msg "program demos (MSan)" # ~20s
5749 tests/scripts/run_demos.py
5750
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005751 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005752 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005753
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005754 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005755
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005756 if [ "$MEMORY" -gt 0 ]; then
5757 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005758 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005759 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005760}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005761
Bence Szépkúti0354d042023-12-06 16:14:37 +01005762component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005763 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005764 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005765 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5766 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005767
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005768 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005769 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005770
Gilles Peskine636c26a2020-03-04 20:46:15 +01005771 # Optional parts (slow; currently broken on OS X because programs don't
5772 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005773 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005774 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005775 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005776 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005777 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005778
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005779 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005780 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005781 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005782 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005783
5784 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005785 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005786 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005787 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005788}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005789
Bence Szépkúti0354d042023-12-06 16:14:37 +01005790component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005791 msg "build: Release, full (clang)"
5792 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5793 scripts/config.py full
5794 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5795 make
5796
5797 msg "test: main suites, Valgrind (full config)"
5798 make memcheck
5799}
5800
Paul Elliott62dc3922021-11-25 17:29:40 +00005801support_test_cmake_out_of_source () {
5802 distrib_id=""
5803 distrib_ver=""
5804 distrib_ver_minor=""
5805 distrib_ver_major=""
5806
5807 # Attempt to parse lsb-release to find out distribution and version. If not
5808 # found this should fail safe (test is supported).
5809 if [[ -f /etc/lsb-release ]]; then
5810
5811 while read -r lsb_line; do
5812 case "$lsb_line" in
5813 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5814 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5815 esac
5816 done < /etc/lsb-release
5817
5818 distrib_ver_major="${distrib_ver%%.*}"
5819 distrib_ver="${distrib_ver#*.}"
5820 distrib_ver_minor="${distrib_ver%%.*}"
5821 fi
5822
5823 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5824 # processor (as the CI does) can create a race condition whereby the build
5825 # fails to see a generated file, despite that file actually having been
5826 # generated. This problem appears to go away with 18.04 or newer, so make
5827 # the out of source tests unsupported on Ubuntu 16.04.
5828 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5829}
5830
Gilles Peskine8f073122018-11-27 15:58:47 +01005831component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005832 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005833 # generates
5834 make neat
5835
Gilles Peskine8f073122018-11-27 15:58:47 +01005836 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005837 MBEDTLS_ROOT_DIR="$PWD"
5838 mkdir "$OUT_OF_SOURCE_DIR"
5839 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005840 # Note: Explicitly generate files as these are turned off in releases
5841 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005842 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005843
Gilles Peskine8f073122018-11-27 15:58:47 +01005844 msg "test: cmake 'out-of-source' build"
5845 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005846 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005847 # Also ensure that there are no error messages such as
5848 # "No such file or directory", which would indicate that some required
5849 # file is missing (ssl-opt.sh tolerates the absence of some files so
5850 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005851 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005852 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005853 cat ssl-opt.err >&2
5854 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005855 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005856 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005857 cd "$MBEDTLS_ROOT_DIR"
5858 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005859}
Andres AGdc192212016-08-31 17:33:13 +01005860
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005861component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005862 # Remove existing generated files so that we use the ones CMake
5863 # generates
5864 make neat
5865
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005866 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005867 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005868 # Note: Explicitly generate files as these are turned off in releases
5869 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005870 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005871 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005872}
Gilles Peskinea3000992022-02-04 00:21:12 +01005873support_test_cmake_as_subdirectory () {
5874 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005875}
5876
Chris Kayd259e342021-03-25 16:03:25 +00005877component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005878 # Remove existing generated files so that we use the ones CMake
5879 # generates
5880 make neat
5881
Chris Kayd259e342021-03-25 16:03:25 +00005882 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005883 cd programs/test/cmake_package
5884 cmake .
5885 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005886 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005887}
Gilles Peskinea3000992022-02-04 00:21:12 +01005888support_test_cmake_as_package () {
5889 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005890}
5891
5892component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005893 # Remove existing generated files so that we use the ones CMake
5894 # generates
5895 make neat
5896
Chris Kayd259e342021-03-25 16:03:25 +00005897 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005898 cd programs/test/cmake_package_install
5899 cmake .
5900 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005901 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005902}
Gilles Peskinea3000992022-02-04 00:21:12 +01005903support_test_cmake_as_package_install () {
5904 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005905}
5906
David Horstmann20550e32023-01-12 14:17:01 +00005907component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005908 # Make a copy of config file to use for the in-tree test
5909 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005910
5911 MBEDTLS_ROOT_DIR="$PWD"
5912 mkdir "$OUT_OF_SOURCE_DIR"
5913 cd "$OUT_OF_SOURCE_DIR"
5914
David Horstmann969c1452023-01-31 10:34:44 +00005915 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005916 cmake "$MBEDTLS_ROOT_DIR"
5917 make
5918
5919 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5920 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005921 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005922 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5923 make
5924
5925 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5926 # In the user config, disable one feature (for simplicity, pick a feature
5927 # that nothing else depends on).
5928 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5929
5930 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5931 make
5932 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5933
5934 rm -f user_config.h full_config.h
5935
5936 cd "$MBEDTLS_ROOT_DIR"
5937 rm -rf "$OUT_OF_SOURCE_DIR"
5938
5939 # Now repeat the test for an in-tree build:
5940
David Horstmann969c1452023-01-31 10:34:44 +00005941 # Restore config for the in-tree test
5942 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005943
David Horstmann969c1452023-01-31 10:34:44 +00005944 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005945 cmake .
5946 make
5947
5948 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5949 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005950 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005951 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5952 make
5953
5954 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5955 # In the user config, disable one feature (for simplicity, pick a feature
5956 # that nothing else depends on).
5957 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5958
5959 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5960 make
5961 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5962
5963 rm -f user_config.h full_config.h
5964}
5965support_build_cmake_custom_config_file () {
5966 support_test_cmake_out_of_source
5967}
5968
David Horstmann041ed422024-05-10 14:37:48 +01005969component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01005970 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01005971 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
5972 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
5973 make
5974}
5975support_build_cmake_programs_no_testing () {
5976 support_test_cmake_out_of_source
5977}
David Horstmann20550e32023-01-12 14:17:01 +00005978
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005979component_build_zeroize_checks () {
5980 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5981
5982 scripts/config.py full
5983
5984 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00005985 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 +01005986}
5987
5988
Gilles Peskine8f073122018-11-27 15:58:47 +01005989component_test_zeroize () {
5990 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5991 # different combinations of compilers and optimization flags by using an
5992 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5993 # system in all cases that the script fails, so we must manually search the
5994 # output to check whether the pass string is present and no failure strings
5995 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005996
Gilles Peskine4976e822019-01-06 19:52:22 +00005997 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5998 # about a spurious message if Gdb tries and fails, so suppress that.
5999 gdb_disable_aslr=
6000 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6001 gdb_disable_aslr='set disable-randomization off'
6002 fi
6003
Gilles Peskine8f073122018-11-27 15:58:47 +01006004 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006005 for compiler in clang gcc; do
6006 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6007 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006008 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6009 grep "The buffer was correctly zeroized" test_zeroize.log
6010 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006011 rm -f test_zeroize.log
6012 make clean
6013 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006014 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006015}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006016
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006017component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006018 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006019 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006020 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006021
6022 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006023 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006024}
6025
6026support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006027 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006028 ver="$(cmake --version)"
6029 ver="${ver#cmake version }"
6030 ver_major="${ver%%.*}"
6031
6032 ver="${ver#*.}"
6033 ver_minor="${ver%%.*}"
6034
6035 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006036}
6037
Gilles Peskinec848d222022-12-09 12:23:35 +01006038component_check_code_style () {
6039 msg "Check C code style"
6040 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006041}
6042
Gilles Peskinec848d222022-12-09 12:23:35 +01006043support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006044 case $(uncrustify --version) in
6045 *0.75.1*) true;;
6046 *) false;;
6047 esac
6048}
6049
Gilles Peskine8f073122018-11-27 15:58:47 +01006050component_check_python_files () {
6051 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006052 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006053}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006054
Joe Subbianid614c0b2021-07-29 11:18:29 +01006055component_check_test_helpers () {
6056 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006057 # unittest writes out mundane stuff like number or tests run on stderr.
6058 # Our convention is to reserve stderr for actual errors, and write
6059 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006060 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006061
Joe Subbiania25ffab2021-08-06 09:41:27 +01006062 msg "unit test: translate_ciphers.py"
6063 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006064}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006065
Valerio Settid9e42512024-05-06 15:59:51 +02006066component_test_psasim() {
Valerio Setti9022f712024-06-27 07:59:39 +02006067 msg "build server library and application"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006068 scripts/config.py crypto
Valerio Settid8b59372024-07-02 12:02:25 +02006069 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006070 helper_psasim_build server
Valerio Settid1b6ef12024-05-07 16:00:21 +02006071
Valerio Settid8b59372024-07-02 12:02:25 +02006072 helper_psasim_cleanup_before_client
Valerio Settif98635c2024-06-10 20:13:13 +02006073
6074 msg "build library for client"
Valerio Settid8b59372024-07-02 12:02:25 +02006075 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006076 helper_psasim_build client
Valerio Settif98635c2024-06-10 20:13:13 +02006077
Valerio Setti5beb2362024-06-24 13:13:17 +02006078 msg "build basic psasim client"
6079 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_base
6080 msg "test basic psasim client"
6081 tests/psa-client-server/psasim/test/run_test.sh psa_client_base
Valerio Settid9e42512024-05-06 15:59:51 +02006082
Valerio Setti5beb2362024-06-24 13:13:17 +02006083 msg "build full psasim client"
6084 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_full
6085 msg "test full psasim client"
6086 tests/psa-client-server/psasim/test/run_test.sh psa_client_full
Valerio Settid9e42512024-05-06 15:59:51 +02006087
Valerio Settid9e42512024-05-06 15:59:51 +02006088 make -C tests/psa-client-server/psasim clean
6089}
Jerry Yud767cc42023-03-31 15:03:55 +08006090
Valerio Setti9022f712024-06-27 07:59:39 +02006091component_test_suite_with_psasim()
6092{
6093 msg "build server library and application"
Valerio Settid8b59372024-07-02 12:02:25 +02006094 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006095 # Modify server's library configuration here (if needed)
6096 helper_psasim_build server
6097
Valerio Settid8b59372024-07-02 12:02:25 +02006098 helper_psasim_cleanup_before_client
Valerio Setti9022f712024-06-27 07:59:39 +02006099
6100 msg "build client library"
Valerio Settid8b59372024-07-02 12:02:25 +02006101 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006102 # PAKE functions are still unsupported from PSASIM
6103 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
6104 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
6105 helper_psasim_build client
6106
6107 msg "build test suites"
6108 make PSASIM=1 CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" tests
6109
Ronald Cron7262b472024-07-22 08:56:10 +02006110 helper_psasim_server kill
Valerio Setti9022f712024-06-27 07:59:39 +02006111 helper_psasim_server start
6112
Valerio Setti1a493832024-07-01 07:29:02 +02006113 # psasim takes an extremely long execution time on some test suites so we
6114 # exclude them from the list.
6115 SKIP_TEST_SUITES="constant_time_hmac,lmots,lms"
6116 export SKIP_TEST_SUITES
6117
Valerio Setti9022f712024-06-27 07:59:39 +02006118 msg "run test suites"
6119 make PSASIM=1 test
6120
6121 helper_psasim_server kill
6122}
6123
Gilles Peskine192c72f2017-12-21 15:59:21 +01006124################################################################
6125#### Termination
6126################################################################
6127
Gilles Peskine8f073122018-11-27 15:58:47 +01006128post_report () {
6129 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006130 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006131
Gilles Peskine8f073122018-11-27 15:58:47 +01006132 final_report
6133}
6134
6135
6136
6137################################################################
6138#### Run all the things
6139################################################################
6140
Gilles Peskine5d996822020-03-28 21:09:21 +01006141# Function invoked by --error-test to test error reporting.
6142pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006143 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006144 if [ $KEEP_GOING -ne 0 ]; then
6145 echo "Expect three failing commands."
6146 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006147 # If the component doesn't run in a subshell, changing error_test_i to an
6148 # invalid integer will cause an error in the loop that runs this function.
6149 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006150 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006151 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006152 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006153 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006154 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006155 make unknown_target
6156 false "this should not be executed"
6157}
6158
Gilles Peskinee48351a2018-11-27 16:06:30 +01006159# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006160run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006161 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006162 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006163
6164 # Unconditionally create a seedfile that's sufficiently long.
6165 # Do this before each component, because a previous component may
6166 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006167 local dd_cmd
6168 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6169 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006170 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006171 esac
6172 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006173
Ronald Cron635a2be2024-07-12 14:30:16 +02006174 if [ -d tf-psa-crypto ]; then
6175 dd_cmd=(dd if=/dev/urandom of=./tf-psa-crypto/tests/seedfile bs=64 count=1)
6176 case $OSTYPE in
6177 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
6178 esac
6179 "${dd_cmd[@]}"
6180 fi
6181
Gilles Peskineec135542021-08-02 23:14:03 +02006182 # Run the component in a subshell, with error trapping and output
6183 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006184 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006185 # We want to keep running if the subshell fails, so 'set -e' must
6186 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006187 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006188 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006189 (
6190 if [ $QUIET -eq 1 ]; then
6191 # msg() will be silenced, so just print the component name here.
6192 echo "${current_component#component_}"
6193 exec >/dev/null
6194 fi
6195 if [ $KEEP_GOING -eq 1 ]; then
6196 # Keep "set -e" off, and run an ERR trap instead to record failures.
6197 set -E
6198 trap err_trap ERR
6199 fi
6200 # The next line is what runs the component
6201 "$@"
6202 if [ $KEEP_GOING -eq 1 ]; then
6203 trap - ERR
6204 exit $last_failure_status
6205 fi
6206 )
6207 component_status=$?
6208 if [ $KEEP_GOING -eq 1 ]; then
6209 set -e
6210 if [ $component_status -ne 0 ]; then
6211 failure_count=$((failure_count + 1))
6212 fi
6213 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006214
6215 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006216 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006217 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006218}
6219
6220# Preliminary setup
6221pre_check_environment
6222pre_initialize_variables
6223pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006224
Dave Rodgman21900632024-02-26 11:41:19 +00006225setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006226pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006227pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006228pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006229
Gilles Peskine878cf602019-01-06 20:50:38 +00006230build_status=0
6231if [ $KEEP_GOING -eq 1 ]; then
6232 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006233fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006234pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006235pre_print_configuration
6236pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006237cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006238if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006239 pre_generate_files
6240fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006241
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006242# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006243for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006244 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006245done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006246unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006247for component in $RUN_COMPONENTS; do
6248 run_component "component_$component"
6249done
Gilles Peskine8f073122018-11-27 15:58:47 +01006250
6251# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006252post_report