blob: 7499651e7faaa65b493213f1106071b9b603698d [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
1101 msg "start server"
1102 psa-client-server/psasim/test/start_server.sh
1103 )
1104 else
1105 (
1106 cd tests
1107 msg "terminate server and cleanup"
1108 psa-client-server/psasim//test/kill_server.sh
Ronald Crone0e26f72024-07-22 11:51:02 +02001109
1110 # Remove temporary files and logs
1111 rm -f psa_notify_*
1112 rm -f psa_service_*
1113 rm -f psa_server.log
Valerio Setti9022f712024-06-27 07:59:39 +02001114 )
1115 fi
1116}
1117
Gilles Peskine192c72f2017-12-21 15:59:21 +01001118################################################################
1119#### Basic checks
1120################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001121
1122#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001123# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001124#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001125# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001126# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001127# 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 +02001128# time, so start with a GCC build).
1129# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001130#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001131# Indicative running times are given for reference.
1132
Gilles Peskine8f073122018-11-27 15:58:47 +01001133component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001134 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001135 tests/scripts/recursion.pl library/*.c
Ronald Cron5b41a652024-07-03 08:59:47 +02001136 tests/scripts/recursion.pl ${PSA_CORE_PATH}/*.c
Ronald Cron709bbf02024-07-03 07:59:30 +02001137 tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001138}
Janos Follathb72c6782016-07-19 14:54:17 +01001139
Gilles Peskine67debb62021-05-18 16:09:50 +02001140component_check_generated_files () {
1141 msg "Check: check-generated-files, files generated with make" # 2s
1142 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001143 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001144
1145 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001146 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001147 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001148 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001149
1150 msg "Check: check-generated-files -u, files absent" # 2s
1151 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001152 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001153 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001154 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001155
1156 # This component ends with the generated files present in the source tree.
1157 # This is necessary for subsequent components!
1158}
1159
Gilles Peskine8f073122018-11-27 15:58:47 +01001160component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001161 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001162 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001163}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001164
Gilles Peskine8f073122018-11-27 15:58:47 +01001165component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001166 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001167 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001168}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001169
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001170component_check_changelog () {
1171 msg "Check: changelog entries" # < 1s
1172 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001173 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001174 if [ -e ChangeLog.new ]; then
1175 # Show the diff for information. It isn't an error if the diff is
1176 # non-empty.
1177 diff -u ChangeLog ChangeLog.new || true
1178 rm ChangeLog.new
1179 fi
1180}
1181
Gilles Peskine8f073122018-11-27 15:58:47 +01001182component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001183 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001184 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001185}
Darryl Greena07039c2018-03-13 16:48:16 +00001186
Gilles Peskine895868b2019-09-19 21:30:05 +02001187component_check_test_cases () {
1188 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001189 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001190 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001191 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001192 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001193 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001194 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001195 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001196}
1197
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001198component_check_test_dependencies () {
1199 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001200 # The purpose of this component is to catch unjustified dependencies on
1201 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1202 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1203 # MBEDTLS_PSA_xxx).
1204 #
1205 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1206 # this component is meant to catch. However a few of them are justified,
1207 # mostly by the absence of a PSA equivalent, so this component includes a
1208 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001209
1210 found="check-test-deps-found-$$"
1211 expected="check-test-deps-expected-$$"
1212
1213 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001214 grep 'depends_on' \
Ronald Cron635a2be2024-07-12 14:30:16 +02001215 tf-psa-crypto/tests/suites/test_suite_psa*.data \
1216 tf-psa-crypto/tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001217 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001218 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001219 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001220
Yanray Wang18040ed2023-11-23 21:29:56 +08001221 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001222 rm -f $expected
1223 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1224 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001225 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1226 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001227 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1228 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001229 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1230 # the test code and that's probably the most convenient way of achieving
1231 # the test's goal.
1232 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1233 # No PSA equivalent - we should probably have one in the future.
1234 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1235 # No PSA equivalent - needed by some init tests
1236 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001237 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001238 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001239
1240 # Compare reality with expectation.
1241 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001242 #
1243 # The output should be empty. When it's not:
1244 # - Each '+' line is a macro that was found but not expected. You want to
1245 # find where that macro occurs, and either replace it with PSA macros, or
1246 # add it to the exceptions list above with a justification.
1247 # - Each '-' line is a macro that was expected but not found; it means the
1248 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001249 diff -U0 $expected $found
1250
1251 rm $found $expected
1252}
1253
Gilles Peskine8f073122018-11-27 15:58:47 +01001254component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001255 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001256 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001257}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001258
Gilles Peskine192c72f2017-12-21 15:59:21 +01001259
Gilles Peskine636c26a2020-03-04 20:46:15 +01001260
Gilles Peskine192c72f2017-12-21 15:59:21 +01001261################################################################
1262#### Build and test many configurations and targets
1263################################################################
1264
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001265component_test_default_out_of_box () {
1266 msg "build: make, default config (out-of-box)" # ~1min
1267 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001268 # Disable fancy stuff
1269 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001270
1271 msg "test: main suites make, default config (out-of-box)" # ~10s
1272 make test
1273
1274 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001275 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001276
1277 msg "program demos: make, default config (out-of-box)" # ~10s
1278 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001279}
1280
Gilles Peskine8f073122018-11-27 15:58:47 +01001281component_test_default_cmake_gcc_asan () {
1282 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001283 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1284 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001285
Gilles Peskine8f073122018-11-27 15:58:47 +01001286 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1287 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001288
Gilles Peskine82b27272019-06-14 18:27:03 +02001289 msg "program demos (ASan build)" # ~10s
1290 tests/scripts/run_demos.py
1291
Gilles Peskine97bea012020-04-23 23:37:45 +02001292 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001293 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001294
Gilles Peskine6848d172023-11-02 19:58:03 +01001295 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001296 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001297
Gilles Peskine8f073122018-11-27 15:58:47 +01001298 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001299 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001300
Gilles Peskine8f073122018-11-27 15:58:47 +01001301 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001302 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001303
1304 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001305 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001306}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001307
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001308component_test_default_cmake_gcc_asan_new_bignum () {
1309 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001310 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001311 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001312 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001313
1314 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1315 make test
1316
1317 msg "test: selftest (ASan build)" # ~ 10s
1318 programs/test/selftest
1319
1320 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1321 tests/ssl-opt.sh
1322
1323 msg "test: compat.sh (ASan build)" # ~ 6 min
1324 tests/compat.sh
1325
1326 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1327 tests/context-info.sh
1328}
1329
Hanno Becker01635512019-02-26 14:27:09 +00001330component_test_full_cmake_gcc_asan () {
1331 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001332 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001333 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1334 make
1335
1336 msg "test: main suites (inc. selftests) (full config, ASan build)"
1337 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001338
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001339 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001340 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001341
Gilles Peskine636c26a2020-03-04 20:46:15 +01001342 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001343 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001344
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001345 # Note: the next two invocations cover all compat.sh test cases.
1346 # We should use the same here and in basic-build-test.sh.
1347 msg "test: compat.sh: default version (full config, ASan build)"
1348 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001349
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001350 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1351 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001352
1353 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001354 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001355}
1356
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001357
1358component_test_full_cmake_gcc_asan_new_bignum () {
1359 msg "build: full config, cmake, gcc, ASan"
1360 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001361 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001362 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001363 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001364
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001365 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001366 make test
1367
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001368 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001369 programs/test/selftest
1370
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001371 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001372 tests/ssl-opt.sh
1373
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001374 # Note: the next two invocations cover all compat.sh test cases.
1375 # We should use the same here and in basic-build-test.sh.
1376 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1377 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001378
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001379 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1380 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001381
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001382 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001383 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001384}
1385
Ronald Cronc3623db2020-10-29 10:51:32 +01001386component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001387 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001388 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001389 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1390 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1391 make
1392
1393 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1394 make test
1395}
1396
David Horstmann4a48bec2024-03-13 15:42:31 +00001397component_test_psa_assume_exclusive_buffers () {
1398 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001399 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001400 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001401 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1402 make
1403
David Horstmann4a48bec2024-03-13 15:42:31 +00001404 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001405 make test
1406}
1407
Gilles Peskinea3548672021-06-17 11:37:52 +02001408# check_renamed_symbols HEADER LIB
1409# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1410# name is LIB.
1411check_renamed_symbols () {
1412 ! nm "$2" | sed 's/.* //' |
1413 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1414}
1415
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001416component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001417 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001418 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001419 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1420 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1421 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1422 # We can only compile, not link, since our test and sample programs
1423 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1424 # is active.
1425 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001426
1427 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1428 # version is not present.
1429 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001430 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001431}
1432
Ryan Everettdaa322a2024-04-18 16:48:55 +01001433component_test_no_rsa_key_pair_generation() {
1434 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001435 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001436 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001437 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001438 make
1439
Ryan Everettdaa322a2024-04-18 16:48:55 +01001440 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001441 make test
1442}
1443
Gilles Peskine782f4112018-11-27 16:11:09 +01001444component_test_ref_configs () {
1445 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001446 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1447 # want to re-generate generated files that depend on it, quite correctly.
1448 # However this doesn't work as the generation script expects a specific
1449 # format for mbedtls_config.h, which the other files don't follow. Also,
1450 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001451 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001452 # whether they're on or off. So, disable cmake's (over-sensitive here)
1453 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001454 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001455 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cron635a2be2024-07-12 14:30:16 +02001456 tests/scripts/test-ref-configs.pl config-tfm.h
Gilles Peskine782f4112018-11-27 16:11:09 +01001457}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001458
Gilles Peskine8f073122018-11-27 15:58:47 +01001459component_test_no_renegotiation () {
1460 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001461 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001462 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001463 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001464
Gilles Peskine8f073122018-11-27 15:58:47 +01001465 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1466 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001467
Gilles Peskine8f073122018-11-27 15:58:47 +01001468 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001469 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001470}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001471
Gilles Peskine636c26a2020-03-04 20:46:15 +01001472component_test_no_pem_no_fs () {
1473 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1474 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1475 scripts/config.py unset MBEDTLS_FS_IO
1476 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1477 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001478 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001479 make
1480
1481 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1482 make test
1483
1484 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001485 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001486}
1487
Gilles Peskine8f073122018-11-27 15:58:47 +01001488component_test_rsa_no_crt () {
1489 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001490 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001491 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001492 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001493
Gilles Peskine8f073122018-11-27 15:58:47 +01001494 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1495 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001496
Gilles Peskine8f073122018-11-27 15:58:47 +01001497 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001498 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001499
Gilles Peskine8f073122018-11-27 15:58:47 +01001500 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001501 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001502
1503 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001504 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001505}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001506
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507component_test_no_ctr_drbg_classic () {
1508 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001509 scripts/config.py full
1510 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001511 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001512 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001513
Dave Rodgman17127e92023-12-14 16:42:48 +00001514 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001515 make
1516
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001517 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001518 make test
1519
Gilles Peskineba749042021-01-13 20:02:03 +01001520 # In this configuration, the TLS test programs use HMAC_DRBG.
1521 # The SSL tests are slow, so run a small subset, just enough to get
1522 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001523 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001524 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001525
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001526 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001527 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001528}
1529
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001530component_test_no_ctr_drbg_use_psa () {
1531 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001532 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001533 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1534 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001535
Dave Rodgman17127e92023-12-14 16:42:48 +00001536 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001537 make
1538
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001539 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1540 make test
1541
1542 # In this configuration, the TLS test programs use HMAC_DRBG.
1543 # The SSL tests are slow, so run a small subset, just enough to get
1544 # confidence that the SSL code copes with HMAC_DRBG.
1545 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001546 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001547
1548 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001549 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001550}
1551
1552component_test_no_hmac_drbg_classic () {
1553 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1554 scripts/config.py full
1555 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1556 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1557 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001558 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001559
Dave Rodgman17127e92023-12-14 16:42:48 +00001560 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001561 make
1562
1563 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001564 make test
1565
Gilles Peskinea2224342020-11-19 22:14:34 +01001566 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1567 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1568 # instead.
1569 # Test SSL with non-deterministic ECDSA. Only test features that
1570 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001571 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001572 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001573
1574 # To save time, only test one protocol version, since this part of
1575 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001576 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001577 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001578}
1579
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001580component_test_no_hmac_drbg_use_psa () {
1581 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1582 scripts/config.py full
1583 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1584 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1585 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1586
Dave Rodgman17127e92023-12-14 16:42:48 +00001587 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001588 make
1589
1590 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1591 make test
1592
1593 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1594 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1595 # instead.
1596 # Test SSL with non-deterministic ECDSA. Only test features that
1597 # might be affected by how ECDSA signature is performed.
1598 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001599 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001600
1601 # To save time, only test one protocol version, since this part of
1602 # the protocol is identical in (D)TLS up to 1.2.
1603 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001604 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001605}
1606
1607component_test_psa_external_rng_no_drbg_classic () {
1608 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1609 scripts/config.py full
1610 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001611 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001612 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001613 scripts/config.py unset MBEDTLS_ENTROPY_C
1614 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1615 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001616 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1617 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1618 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001619 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1620 # the SSL test programs don't have an RNG and can't work. Explicitly
1621 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001622 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001623
1624 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1625 make test
1626
Gilles Peskine8eb29432021-02-03 20:07:11 +01001627 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001628 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001629}
1630
1631component_test_psa_external_rng_no_drbg_use_psa () {
1632 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001633 scripts/config.py full
1634 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001635 scripts/config.py unset MBEDTLS_ENTROPY_C
1636 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1637 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001638 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1639 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1640 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001641 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001642
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001643 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001644 make test
1645
Gilles Peskine8eb29432021-02-03 20:07:11 +01001646 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001647 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001648}
1649
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001650component_test_psa_external_rng_use_psa_crypto () {
1651 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1652 scripts/config.py full
1653 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1654 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1655 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001656 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001657
1658 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1659 make test
1660
1661 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1662 tests/ssl-opt.sh -f 'Default\|opaque'
1663}
1664
Gilles Peskine801c4332023-04-28 21:04:28 +02001665component_test_psa_inject_entropy () {
1666 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1667 scripts/config.py full
1668 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1669 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1670 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1671 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1672 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1673 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001674 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 +02001675
1676 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1677 make test
1678}
1679
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001680component_test_sw_inet_pton () {
1681 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1682
1683 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1684 scripts/config.py set MBEDTLS_TEST_HOOKS
1685 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1686
1687 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1688 make test
1689}
1690
Valerio Settia41654d2024-02-08 10:33:11 +01001691component_full_no_pkparse_pkwrite() {
1692 msg "build: full without pkparse and pkwrite"
1693
1694 scripts/config.py crypto_full
1695 scripts/config.py unset MBEDTLS_PK_PARSE_C
1696 scripts/config.py unset MBEDTLS_PK_WRITE_C
1697
Valerio Settia41654d2024-02-08 10:33:11 +01001698 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1699
1700 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
Ronald Cron709bbf02024-07-03 07:59:30 +02001701 not grep mbedtls_pk_parse_key ${BUILTIN_SRC_PATH}/pkparse.o
1702 not grep mbedtls_pk_write_key_der ${BUILTIN_SRC_PATH}/pkwrite.o
Valerio Settia41654d2024-02-08 10:33:11 +01001703
1704 msg "test: full without pkparse and pkwrite"
1705 make test
1706}
1707
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001708component_test_crypto_full_md_light_only () {
1709 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001710 scripts/config.py crypto_full
Ronald Crona67f1be2024-05-23 15:50:27 +02001711
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001712 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001713 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001714 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001715 scripts/config.py unset MBEDTLS_HKDF_C
1716 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001717 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001718 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001719 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Ronald Crona67f1be2024-05-23 15:50:27 +02001720 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001721 # Disable things that would auto-enable MD_C
1722 scripts/config.py unset MBEDTLS_PKCS5_C
1723
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001724 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1725 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001726 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001727
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001728 # Make sure we don't have the HMAC functions, but the hashing functions
Ronald Cron709bbf02024-07-03 07:59:30 +02001729 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
1730 grep mbedtls_md ${BUILTIN_SRC_PATH}/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001731
1732 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001733 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001734}
1735
Ronald Cron8dbea482024-05-23 16:04:11 +02001736component_test_full_no_cipher () {
1737 msg "build: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001738
1739 scripts/config.py full
1740 scripts/config.py unset MBEDTLS_CIPHER_C
1741
Ronald Cron8dbea482024-05-23 16:04:11 +02001742 # The built-in implementation of the following algs/key-types depends
1743 # on CIPHER_C so we disable them.
1744 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1745 # so we keep them enabled.
1746 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1747 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1748 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1749 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1750 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1751 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1752 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1753 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1754 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
1755 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
1756 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
1757
Valerio Settic84d9402023-10-23 14:58:25 +02001758 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001759 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001760 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001761
Gilles Peskine21570cf2023-12-22 11:49:50 +01001762 make
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001763
Valerio Setti7e710e82023-08-25 09:14:15 +02001764 # Ensure that CIPHER_C was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02001765 not grep mbedtls_cipher_init ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti7e710e82023-08-25 09:14:15 +02001766
Ronald Cron8dbea482024-05-23 16:04:11 +02001767 msg "test: full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001768 make test
1769}
1770
Valerio Settibdfecb62023-11-07 15:37:20 +01001771component_test_full_no_ccm() {
1772 msg "build: full no PSA_WANT_ALG_CCM"
1773
1774 # Full config enables:
1775 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1776 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1777 scripts/config.py full
1778
1779 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1780 # enabled, but not used from TLS since USE_PSA is set.
1781 # This is helpful to ensure that TLS tests below have proper dependencies.
1782 #
1783 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1784 # PSA_WANT_ALG_CCM to be re-enabled.
1785 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1786
Gilles Peskine21570cf2023-12-22 11:49:50 +01001787 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001788
1789 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001790 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001791}
1792
1793component_test_full_no_ccm_star_no_tag() {
1794 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1795
1796 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1797 scripts/config.py full
1798
1799 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1800 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1801 # This basically disables all unauthenticated ciphers on the PSA side, while
1802 # keeping AEADs enabled.
1803 #
1804 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1805 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1806 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1807 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1808 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1809 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1810 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1811 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1812 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1813 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1814
Gilles Peskine21570cf2023-12-22 11:49:50 +01001815 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001816
1817 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Ronald Cron5b41a652024-07-03 08:59:47 +02001818 not grep mbedtls_psa_cipher ${PSA_CORE_PATH}/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001819
1820 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001821 make test
1822}
1823
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001824component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001825 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001826
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001827 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001828 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001829 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001830 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001831 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001832 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1833 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001834 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001835 scripts/config.py unset MBEDTLS_GCM_C
1836 scripts/config.py unset MBEDTLS_CCM_C
1837 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001838 #Disable TLS 1.3 (as no AEAD)
1839 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001840 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1841 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1842 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001843 # 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 +01001844 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001845 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001846 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001847 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001848 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1849 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001850 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001851 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001852 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001853
Przemek Stekiel9550c052022-09-28 09:51:55 +02001854 make
1855
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001856 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001857 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001858
1859 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001860}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001861
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001862component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001863 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001864
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001865 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001866 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001867 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001868 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001869 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001870 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1871 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001872 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001873 scripts/config.py unset MBEDTLS_GCM_C
1874 scripts/config.py unset MBEDTLS_CCM_C
1875 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001876 #Disable TLS 1.3 (as no AEAD)
1877 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001878 # 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 +01001879 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001880 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001881 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001882 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001883 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001884 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001885 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001886 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001887
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001888 make
1889
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001890 msg "test: default with only CBC-legacy cipher use psa"
1891 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001892
1893 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1894 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001895}
1896
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001897component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001898 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001899
1900 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001901 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001902 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001903 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001904 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001905 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1906 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001907 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001908 scripts/config.py unset MBEDTLS_GCM_C
1909 scripts/config.py unset MBEDTLS_CCM_C
1910 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001911 #Disable TLS 1.3 (as no AEAD)
1912 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001913 # 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 +01001914 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001915 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1916 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1917 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001918 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001919 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001920 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001921 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001922
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001923 make
1924
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001925 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001926 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001927
1928 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1929 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001930}
1931
Valerio Setti9f0ec532022-11-08 13:03:24 +01001932# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1933# that we could use for interop testing. However, we now have sort of two
1934# implementations ourselves: one using PSA, the other not. At least test that
1935# these two interoperate with each other.
1936component_test_tls1_2_ecjpake_compatibility() {
1937 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1938 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001939 # Explicitly make lib first to avoid a race condition:
1940 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1941 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001942 make -C programs ssl/ssl_server2 ssl/ssl_client2
1943 cp programs/ssl/ssl_server2 s2_no_use_psa
1944 cp programs/ssl/ssl_client2 c2_no_use_psa
1945
1946 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1947 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1948 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001949 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001950 make -C programs ssl/ssl_server2 ssl/ssl_client2
1951 make -C programs test/udp_proxy test/query_compile_time_config
1952
Valerio Setti70e02902022-12-02 16:21:56 +01001953 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1954 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1955 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1956 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1957 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1958 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1959 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1960 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 +01001961
1962 rm s2_no_use_psa c2_no_use_psa
1963}
1964
Gilles Peskine636c26a2020-03-04 20:46:15 +01001965component_test_everest () {
1966 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001967 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1968 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1969 make
1970
1971 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1972 make test
1973
Gilles Peskine6848d172023-11-02 19:58:03 +01001974 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001975 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001976
Gilles Peskine636c26a2020-03-04 20:46:15 +01001977 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001978 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001979
1980 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1981 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001982 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001983}
1984
Gilles Peskined3beca92020-07-03 00:15:37 +02001985component_test_everest_curve25519_only () {
1986 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001987 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02001988 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1989 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001990 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
1991 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
1992 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02001993 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1994 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001995 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01001996 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
1997
Gilles Peskined3beca92020-07-03 00:15:37 +02001998 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001999 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002000 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
2001 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02002002
Dave Rodgman17127e92023-12-14 16:42:48 +00002003 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002004
2005 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2006 make test
2007}
2008
Gilles Peskine8f073122018-11-27 15:58:47 +01002009component_test_small_ssl_out_content_len () {
2010 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002011 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2012 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002013 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002014 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002015
Gilles Peskine8f073122018-11-27 15:58:47 +01002016 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002017 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002018}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002019
Gilles Peskine8f073122018-11-27 15:58:47 +01002020component_test_small_ssl_in_content_len () {
2021 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002022 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2023 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002024 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002025 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002026
Gilles Peskine8f073122018-11-27 15:58:47 +01002027 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002028 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002029}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002030
Gilles Peskine8f073122018-11-27 15:58:47 +01002031component_test_small_ssl_dtls_max_buffering () {
2032 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002033 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002034 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002035 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002036
Gilles Peskine8f073122018-11-27 15:58:47 +01002037 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002038 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 +01002039}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002040
Gilles Peskine8f073122018-11-27 15:58:47 +01002041component_test_small_mbedtls_ssl_dtls_max_buffering () {
2042 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002043 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002044 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002045 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002046
Gilles Peskine8f073122018-11-27 15:58:47 +01002047 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002048 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002049}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002050
Gilles Peskine75cc7712019-09-06 19:47:17 +02002051component_test_psa_collect_statuses () {
2052 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002053 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002054 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002055 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002056 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002057 rm -f tests/statuses.log
2058}
2059
Gilles Peskine8f073122018-11-27 15:58:47 +01002060component_test_full_cmake_clang () {
2061 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002062 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002063 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 +01002064 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002065
k-stachowiak0291cb72019-06-26 15:52:12 +02002066 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002067 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002068
Gilles Peskineda6017c2022-10-30 21:02:40 +01002069 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2070 programs/test/cpp_dummy_build
2071
Gilles Peskine6848d172023-11-02 19:58:03 +01002072 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002073 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002074
Gilles Peskine82b27272019-06-14 18:27:03 +02002075 msg "program demos (full config, clang)" # ~10s
2076 tests/scripts/run_demos.py
2077
k-stachowiak0291cb72019-06-26 15:52:12 +02002078 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002079 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002080
Gilles Peskine8f073122018-11-27 15:58:47 +01002081 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002082 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002083}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002084
Gilles Peskine0c671602022-11-29 16:01:41 +01002085skip_suites_without_constant_flow () {
2086 # Skip the test suites that don't have any constant-flow annotations.
2087 # This will need to be adjusted if we ever start declaring things as
2088 # secret from macros or functions inside tests/include or tests/src.
2089 SKIP_TEST_SUITES=$(
2090 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2091 sed 's/test_suite_//; s/\.function$//' |
Ronald Cron635a2be2024-07-12 14:30:16 +02002092 tr '\n' ,),$(
2093 git -C tf-psa-crypto/tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2094 sed 's/test_suite_//; s/\.function$//' |
Gilles Peskine0c671602022-11-29 16:01:41 +01002095 tr '\n' ,)
2096 export SKIP_TEST_SUITES
2097}
2098
Dave Rodgman246210e2023-07-31 18:07:44 +01002099skip_all_except_given_suite () {
2100 # Skip all but the given test suite
2101 SKIP_TEST_SUITES=$(
2102 ls -1 tests/suites/test_suite_*.function |
2103 grep -v $1.function |
2104 sed 's/tests.suites.test_suite_//; s/\.function$//' |
Ronald Cron635a2be2024-07-12 14:30:16 +02002105 tr '\n' ,),$(
2106 ls -1 tf-psa-crypto/tests/suites/test_suite_*.function |
2107 grep -v $1.function |
2108 sed 's/tf-psa-crypto.tests.suites.test_suite_//; s/\.function$//' |
Dave Rodgman246210e2023-07-31 18:07:44 +01002109 tr '\n' ,)
2110 export SKIP_TEST_SUITES
2111}
2112
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002113component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002114 # This tests both (1) accesses to undefined memory, and (2) branches or
2115 # memory access depending on secret values. To distinguish between those:
2116 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2117 # - or alternatively, change the build type to MemSanDbg, which enables
2118 # origin tracking and nicer stack traces (which are useful for debugging
2119 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002120 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2121 scripts/config.py full
2122 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2123 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2124 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2125 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2126 make
2127
2128 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2129 make test
2130}
2131
2132component_test_memsan_constant_flow_psa () {
2133 # This tests both (1) accesses to undefined memory, and (2) branches or
2134 # memory access depending on secret values. To distinguish between those:
2135 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2136 # - or alternatively, change the build type to MemSanDbg, which enables
2137 # origin tracking and nicer stack traces (which are useful for debugging
2138 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002139 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002140 scripts/config.py full
2141 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2142 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2143 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2144 make
2145
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002146 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002147 make test
2148}
2149
Bence Szépkúti0354d042023-12-06 16:14:37 +01002150component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002151 # This tests both (1) everything that valgrind's memcheck usually checks
2152 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2153 # etc.) and (2) branches or memory access depending on secret values,
2154 # which will be reported as uninitialized memory. To distinguish between
2155 # secret and actually uninitialized:
2156 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2157 # - or alternatively, build with debug info and manually run the offending
2158 # test suite with valgrind --track-origins=yes, then check if the origin
2159 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002160 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2161 scripts/config.py full
2162 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2163 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002164 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002165 cmake -D CMAKE_BUILD_TYPE:String=Release .
2166 make
2167
2168 # this only shows a summary of the results (how many of each type)
2169 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002170 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002171 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002172
2173 # Test asm path in constant time module - by default, it will test the plain C
2174 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2175 msg "test: valgrind asm constant_time"
2176 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2177 skip_all_except_given_suite test_suite_constant_time
2178 cmake -D CMAKE_BUILD_TYPE:String=Release .
2179 make clean
2180 make
2181 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002182}
2183
Bence Szépkúti0354d042023-12-06 16:14:37 +01002184component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002185 # This tests both (1) everything that valgrind's memcheck usually checks
2186 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2187 # etc.) and (2) branches or memory access depending on secret values,
2188 # which will be reported as uninitialized memory. To distinguish between
2189 # secret and actually uninitialized:
2190 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2191 # - or alternatively, build with debug info and manually run the offending
2192 # test suite with valgrind --track-origins=yes, then check if the origin
2193 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002194 msg "build: cmake release GCC, full config with constant flow testing"
2195 scripts/config.py full
2196 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002197 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002198 cmake -D CMAKE_BUILD_TYPE:String=Release .
2199 make
2200
2201 # this only shows a summary of the results (how many of each type)
2202 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002203 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002204 make memcheck
2205}
2206
Janos Follath9338cac2023-10-04 18:55:39 +01002207component_test_tsan () {
2208 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002209 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002210 scripts/config.py set MBEDTLS_THREADING_C
2211 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002212 # Self-tests do not currently use multiple threads.
2213 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002214
Ryan6caf84f2024-03-05 13:57:00 +00002215 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2216 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2217
Janos Follath9338cac2023-10-04 18:55:39 +01002218 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2219 make
2220
2221 msg "test: main suites (TSan)"
2222 make test
2223}
2224
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002225component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002226 # Test that removing the deprecated features from the default
2227 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002228 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2229 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002230 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002231
2232 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2233 make test
2234}
2235
2236component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002237 msg "build: make, full_no_deprecated config" # ~ 30s
2238 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002239 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002240
Gilles Peskine30de2e82020-04-20 21:39:22 +02002241 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002242 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002243
2244 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2245 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002246}
2247
Gilles Peskine8386ea22020-04-30 09:07:29 +02002248component_test_full_no_deprecated_deprecated_warning () {
2249 # Test that there is nothing deprecated in "full_no_deprecated".
2250 # A deprecated feature would trigger a warning (made fatal) from
2251 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002252 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2253 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002254 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2255 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002256 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002257
Gilles Peskine30de2e82020-04-20 21:39:22 +02002258 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002259 make test
2260}
2261
Gilles Peskine8386ea22020-04-30 09:07:29 +02002262component_test_full_deprecated_warning () {
2263 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2264 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002265 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002266 scripts/config.py full
2267 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002268 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002269 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2270 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002271 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002272
Gilles Peskine8386ea22020-04-30 09:07:29 +02002273 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2274 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2275 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002276 # Expect warnings from '#warning' directives in check_config.h and
2277 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002278 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 +01002279
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002280 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2281 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002282
2283 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2284 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002285}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002286
Gilles Peskineec541fe2020-01-31 14:24:14 +01002287# Check that the specified libraries exist and are empty.
2288are_empty_libraries () {
2289 nm "$@" >/dev/null 2>/dev/null
2290 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2291}
2292
2293component_build_crypto_default () {
2294 msg "build: make, crypto only"
2295 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002296 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002297 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002298}
2299
2300component_build_crypto_full () {
2301 msg "build: make, crypto only, full config"
2302 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002303 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002304 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002305}
2306
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002307component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002308 msg "build: make, config for PSA crypto service"
2309 scripts/config.py crypto
2310 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2311 # Disable things that are not needed for just cryptography, to
2312 # reach a configuration that would be typical for a PSA cryptography
2313 # service providing all implemented PSA algorithms.
2314 # System stuff
2315 scripts/config.py unset MBEDTLS_ERROR_C
2316 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002317 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002318 # Crypto stuff with no PSA interface
2319 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002320 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002321 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002322 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002323 scripts/config.py unset MBEDTLS_NIST_KW_C
2324 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2325 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2326 scripts/config.py unset MBEDTLS_PKCS12_C
2327 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002328 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2329 # in PSA code to work with RSA keys. We don't require users to set those:
2330 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002331 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002332 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002333 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002334 make CFLAGS='-O1 -Werror' all test
2335 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2336}
2337
Gilles Peskineec541fe2020-01-31 14:24:14 +01002338component_build_crypto_baremetal () {
2339 msg "build: make, crypto only, baremetal config"
2340 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002341 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002342 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002343}
Daniel Axtens446af202020-09-02 21:30:13 +10002344support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002345 support_build_baremetal "$@"
2346}
2347
2348component_build_baremetal () {
2349 msg "build: make, baremetal config"
2350 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002351 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002352}
2353support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002354 # Older Glibc versions include time.h from other headers such as stdlib.h,
2355 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2356 # problem, Ubuntu 18.04 is ok.
2357 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2358}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002359
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002360# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002361component_test_depends_py_cipher_id () {
2362 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002363 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002364}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002365
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002366component_test_depends_py_cipher_chaining () {
2367 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002368 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002369}
2370
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002371component_test_depends_py_cipher_padding () {
2372 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002373 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002374}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002375
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002376component_test_depends_py_curves () {
2377 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002378 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002379}
2380
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002381component_test_depends_py_hashes () {
2382 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002383 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002384}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002385
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002386component_test_depends_py_kex () {
2387 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002388 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002389}
2390
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002391component_test_depends_py_pkalgs () {
2392 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002393 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002394}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002395
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002396# PSA equivalents of the depends.py tests
2397component_test_depends_py_cipher_id_psa () {
2398 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002399 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002400}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002401
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002402component_test_depends_py_cipher_chaining_psa () {
2403 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002404 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002405}
2406
2407component_test_depends_py_cipher_padding_psa () {
2408 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002409 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002410}
2411
2412component_test_depends_py_curves_psa () {
2413 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002414 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002415}
2416
2417component_test_depends_py_hashes_psa () {
2418 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002419 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002420}
2421
2422component_test_depends_py_kex_psa () {
2423 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002424 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002425}
2426
2427component_test_depends_py_pkalgs_psa () {
2428 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002429 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002430}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002431
Valerio Setti6bed64e2024-01-17 15:21:44 +01002432component_test_psa_crypto_config_ffdh_2048_only () {
2433 msg "build: full config - only DH 2048"
2434
2435 scripts/config.py full
2436
2437 # Disable all DH groups other than 2048.
2438 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2439 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2440 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2441 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2442
2443 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2444
2445 msg "test: full config - only DH 2048"
2446 make test
2447
2448 msg "ssl-opt: full config - only DH 2048"
2449 tests/ssl-opt.sh -f "ffdh"
2450}
2451
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002452component_build_no_pk_rsa_alt_support () {
2453 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2454
2455 scripts/config.py full
2456 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2457 scripts/config.py set MBEDTLS_RSA_C
2458 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2459
2460 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002461 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002462}
2463
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002464component_build_module_alt () {
2465 msg "build: MBEDTLS_XXX_ALT" # ~30s
2466 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002467
2468 # Disable options that are incompatible with some ALT implementations:
Thomas Daubney62af02c2024-06-14 10:37:13 +01002469 # aesni.c references mbedtls_aes_context fields directly.
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002470 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002471 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002472 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2473 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002474 # You can only have one threading implementation: alt or pthread, not both.
2475 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002476 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2477 # directly and assumes the implementation works with partial groups.
2478 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002479 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2480 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2481 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002482 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2483 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2484 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002485
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002486 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2487 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2488 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002489
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002490 # We can only compile, not link, since we don't have any implementations
2491 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002492 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002493}
2494
Gilles Peskine64996c32024-01-23 20:25:47 +01002495component_test_no_psa_crypto_full_cmake_asan() {
2496 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2497 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002498 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002499 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002500 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002501 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002502 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002503 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002504 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002505 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002506 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002507 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002508 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002509 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002510
Gilles Peskine64996c32024-01-23 20:25:47 +01002511 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002512 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002513
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002514 # Note: ssl-opt.sh has some test cases that depend on
2515 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2516 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002517 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002518 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002519
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002520 # Note: the next two invocations cover all compat.sh test cases.
2521 # We should use the same here and in basic-build-test.sh.
2522 msg "test: compat.sh: default version (full minus PSA crypto)"
2523 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002524
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002525 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002526 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002527}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002528
Ronald Cron403c15c2021-09-13 09:38:05 +02002529component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002530 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002531
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002532 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002533 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002534 $(helper_get_psa_key_type_list "ECC") \
2535 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002536
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002537 # Configure
2538 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002539
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002540 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002541 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002542
2543 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002544 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002545
2546 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002547 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2548 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2549
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002550 # Build
2551 # -----
2552
2553 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002554 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2555 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002556
2557 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2558
Valerio Setti3fe105b2023-10-30 11:08:12 +01002559 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002560
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002561 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002562 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002563
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002564 # Run the tests
2565 # -------------
2566
Ronald Cron403c15c2021-09-13 09:38:05 +02002567 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2568 make test
2569}
2570
Valerio Setti44b178c2023-03-22 14:02:57 +01002571component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002572 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002573
2574 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002575 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002576 $(helper_get_psa_key_type_list "ECC") \
2577 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002578
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002579 # Configure
2580 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002581
Ronald Cron46ac0652024-03-18 12:39:04 +01002582 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002583 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002584
Valerio Setti44b178c2023-03-22 14:02:57 +01002585 # Disable the module that's accelerated
2586 scripts/config.py unset MBEDTLS_ECDH_C
2587
2588 # Disable things that depend on it
2589 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2590 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2591 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2592 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2593 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2594
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002595 # Build
2596 # -----
2597
2598 helper_libtestdriver1_make_drivers "$loc_accel_list"
2599
Valerio Setti3fe105b2023-10-30 11:08:12 +01002600 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002601
Valerio Setti44b178c2023-03-22 14:02:57 +01002602 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002603 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002604
2605 # Run the tests
2606 # -------------
2607
Valerio Setti44b178c2023-03-22 14:02:57 +01002608 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002609 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002610}
2611
Przemek Stekieldccb2022023-05-11 10:48:50 +02002612component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002613 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002614
2615 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002616 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002617 $(helper_get_psa_key_type_list "DH") \
2618 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002619
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002620 # Configure
2621 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002622
Przemek Stekiel565353e2023-07-05 11:07:07 +02002623 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002624 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002625
2626 # Disable the module that's accelerated
2627 scripts/config.py unset MBEDTLS_DHM_C
2628
2629 # Disable things that depend on it
2630 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2631 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2632
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002633 # Build
2634 # -----
2635
2636 helper_libtestdriver1_make_drivers "$loc_accel_list"
2637
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002638 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002639
2640 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002641 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Przemek Stekieldccb2022023-05-11 10:48:50 +02002642
2643 # Run the tests
2644 # -------------
2645
Gilles Peskine14302ed2023-07-19 19:30:04 +02002646 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002647 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002648
Gilles Peskine14302ed2023-07-19 19:30:04 +02002649 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002650 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002651}
2652
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002653component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002654 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002655
2656 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002657 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002658
2659 # Disable things that are not supported
2660 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2661 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002662 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002663
Gilles Peskine14302ed2023-07-19 19:30:04 +02002664 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002665 make test
2666
Gilles Peskine14302ed2023-07-19 19:30:04 +02002667 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002668 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002669}
2670
Valerio Setti44b178c2023-03-22 14:02:57 +01002671component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002672 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002673
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002674 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002675 $(helper_get_psa_key_type_list "ECC") \
2676 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002677
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002678 # Configure
2679 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002680
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002681 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002682
2683 # Make built-in fallback not available
2684 scripts/config.py unset MBEDTLS_ECJPAKE_C
2685 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2686
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002687 # Build
2688 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002689
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002690 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002691
Valerio Setti3fe105b2023-10-30 11:08:12 +01002692 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002693
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002694 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002695 not grep mbedtls_ecjpake_init ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002696
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002697 # Run the tests
2698 # -------------
2699
Gilles Peskine14302ed2023-07-19 19:30:04 +02002700 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002701 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002702}
2703
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002704component_test_psa_crypto_config_accel_ecc_some_key_types () {
2705 msg "build: full with accelerated EC algs and some key types"
2706
2707 # Algorithms and key types to accelerate
2708 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2709 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2710 ALG_ECDH \
2711 ALG_JPAKE \
2712 KEY_TYPE_ECC_PUBLIC_KEY \
2713 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2714 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002715 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2716 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002717
2718 # Configure
2719 # ---------
2720
2721 # start with config full for maximum coverage (also enables USE_PSA)
2722 helper_libtestdriver1_adjust_config "full"
2723
2724 # Disable modules that are accelerated - some will be re-enabled
2725 scripts/config.py unset MBEDTLS_ECDSA_C
2726 scripts/config.py unset MBEDTLS_ECDH_C
2727 scripts/config.py unset MBEDTLS_ECJPAKE_C
2728 scripts/config.py unset MBEDTLS_ECP_C
2729
2730 # Disable all curves - those that aren't accelerated should be re-enabled
2731 helper_disable_builtin_curves
2732
2733 # Restartable feature is not yet supported by PSA. Once it will in
2734 # the future, the following line could be removed (see issues
2735 # 6061, 6332 and following ones)
2736 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2737
2738 # this is not supported by the driver API yet
2739 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2740
2741 # Build
2742 # -----
2743
2744 # These hashes are needed for some ECDSA signature tests.
2745 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2746 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2747 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2748
Valerio Setti3fe105b2023-10-30 11:08:12 +01002749 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002750
2751 # ECP should be re-enabled but not the others
Ronald Cron709bbf02024-07-03 07:59:30 +02002752 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2753 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2754 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
2755 grep mbedtls_ecp ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002756
2757 # Run the tests
2758 # -------------
2759
2760 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002761 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002762}
2763
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002764# Run tests with only (non-)Weierstrass accelerated
2765# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002766# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2767# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002768common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002769 weierstrass=$1
2770 if [ $weierstrass -eq 1 ]; then
2771 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002772 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002773 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002774 fi
2775
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002776 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002777
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002778 # Note: Curves are handled in a special way by the libtestdriver machinery,
2779 # so we only want to include them in the accel list when building the main
2780 # libraries, hence the use of a separate variable.
2781 # Note: the following loop is a modified version of
2782 # helper_get_psa_curve_list that only keeps Weierstrass families.
2783 loc_weierstrass_list=""
2784 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002785 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2786 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002787 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002788 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002789 ;;
2790 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002791 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002792 ;;
2793 esac
2794 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002795 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002796 loc_curve_list=$loc_weierstrass_list
2797 else
2798 loc_curve_list=$loc_non_weierstrass_list
2799 fi
2800
Valerio Setti3fe105b2023-10-30 11:08:12 +01002801 # Algorithms and key types to accelerate
2802 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2803 ALG_ECDH \
2804 ALG_JPAKE \
2805 $(helper_get_psa_key_type_list "ECC") \
2806 $loc_curve_list"
2807
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002808 # Configure
2809 # ---------
2810
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002811 # Start with config crypto_full and remove PK_C:
2812 # that's what's supported now, see docs/driver-only-builds.md.
2813 helper_libtestdriver1_adjust_config "crypto_full"
2814 scripts/config.py unset MBEDTLS_PK_C
2815 scripts/config.py unset MBEDTLS_PK_PARSE_C
2816 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002817
2818 # Disable modules that are accelerated - some will be re-enabled
2819 scripts/config.py unset MBEDTLS_ECDSA_C
2820 scripts/config.py unset MBEDTLS_ECDH_C
2821 scripts/config.py unset MBEDTLS_ECJPAKE_C
2822 scripts/config.py unset MBEDTLS_ECP_C
2823
2824 # Disable all curves - those that aren't accelerated should be re-enabled
2825 helper_disable_builtin_curves
2826
2827 # Restartable feature is not yet supported by PSA. Once it will in
2828 # the future, the following line could be removed (see issues
2829 # 6061, 6332 and following ones)
2830 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2831
2832 # this is not supported by the driver API yet
2833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2834
2835 # Build
2836 # -----
2837
2838 # These hashes are needed for some ECDSA signature tests.
2839 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2840 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2841 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2842
Valerio Settiac7a8092023-10-31 12:23:44 +01002843 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002844
2845 # We expect ECDH to be re-enabled for the missing curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002846 grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002847 # We expect ECP to be re-enabled, however the parts specific to the
2848 # families of curves that are accelerated should be ommited.
2849 # - functions with mxz in the name are specific to Montgomery curves
2850 # - ecp_muladd is specific to Weierstrass curves
Ronald Cron709bbf02024-07-03 07:59:30 +02002851 ##nm ${BUILTIN_SRC_PATH}/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002852 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002853 not grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2854 grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002855 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002856 grep mbedtls_ecp_muladd ${BUILTIN_SRC_PATH}/ecp.o
2857 not grep mxz ${BUILTIN_SRC_PATH}/ecp.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002858 fi
2859 # We expect ECDSA and ECJPAKE to be re-enabled only when
2860 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002861 if [ $weierstrass -eq 1 ]; then
Ronald Cron709bbf02024-07-03 07:59:30 +02002862 not grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2863 not grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002864 else
Ronald Cron709bbf02024-07-03 07:59:30 +02002865 grep mbedtls_ecdsa ${BUILTIN_SRC_PATH}/ecdsa.o
2866 grep mbedtls_ecjpake ${BUILTIN_SRC_PATH}/ecjpake.o
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002867 fi
2868
2869 # Run the tests
2870 # -------------
2871
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002872 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2873 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002874}
2875
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002876component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002877 common_test_psa_crypto_config_accel_ecc_some_curves 1
2878}
2879
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002880component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002881 common_test_psa_crypto_config_accel_ecc_some_curves 0
2882}
2883
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002884# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2885# ECDH, ECDSA) with and without drivers.
2886# The input parameter is a boolean value which indicates:
2887# - 0 keep built-in EC algs,
2888# - 1 exclude built-in EC algs (driver only).
2889#
2890# This is used by the two following components to ensure they always use the
2891# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002892# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2893# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002894# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002895config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002896 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002897 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002898 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002899 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002900 # Disable modules that are accelerated
2901 scripts/config.py unset MBEDTLS_ECDSA_C
2902 scripts/config.py unset MBEDTLS_ECDH_C
2903 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002904 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002905 fi
2906
2907 # Restartable feature is not yet supported by PSA. Once it will in
2908 # the future, the following line could be removed (see issues
2909 # 6061, 6332 and following ones)
2910 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002911}
2912
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002913# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2914component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002915 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002916
2917 # Algorithms and key types to accelerate
2918 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2919 ALG_ECDH \
2920 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002921 $(helper_get_psa_key_type_list "ECC") \
2922 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002923
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002924 # Configure
2925 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002926
2927 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002928 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002929
Valerio Setti0a342c92023-09-01 09:12:31 +02002930 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002931 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2932 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002933
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002934 # Build
2935 # -----
2936
2937 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002938 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2939 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002940 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2941
Valerio Setti3fe105b2023-10-30 11:08:12 +01002942 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002943
2944 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02002945 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
2946 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
2947 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
2948 not grep mbedtls_ecp_mul ${BUILTIN_SRC_PATH}/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002949
2950 # Run the tests
2951 # -------------
2952
Gilles Peskine14302ed2023-07-19 19:30:04 +02002953 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002954 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002955
Gilles Peskine14302ed2023-07-19 19:30:04 +02002956 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002957 tests/ssl-opt.sh
2958}
2959
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002960# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2961component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002962 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002963
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002964 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002965
Gilles Peskine21570cf2023-12-22 11:49:50 +01002966 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002967
Gilles Peskine14302ed2023-07-19 19:30:04 +02002968 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002969 make test
2970
Gilles Peskine14302ed2023-07-19 19:30:04 +02002971 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002972 tests/ssl-opt.sh
2973}
2974
Valerio Settie618cb02023-04-12 14:59:16 +02002975# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002976# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2977# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002978# to ensure that both tests use the same underlying configuration when testing
2979# driver's coverage with analyze_outcomes.py.
2980#
2981# This functions accepts 1 boolean parameter as follows:
2982# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2983# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2984# - 0: include built-in implementation of EC algorithms.
2985#
2986# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2987# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002988config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002989 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002990 # start with full config for maximum coverage (also enables USE_PSA)
2991 helper_libtestdriver1_adjust_config "full"
2992
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002993 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002994 # Disable modules that are accelerated
2995 scripts/config.py unset MBEDTLS_ECDSA_C
2996 scripts/config.py unset MBEDTLS_ECDH_C
2997 scripts/config.py unset MBEDTLS_ECJPAKE_C
2998 # Disable ECP module (entirely)
2999 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003000 fi
3001
Valerio Settiaecd32c2023-06-14 10:42:31 +02003002 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3003 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003004 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003005 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003006
Valerio Settie618cb02023-04-12 14:59:16 +02003007 # Restartable feature is not yet supported by PSA. Once it will in
3008 # the future, the following line could be removed (see issues
3009 # 6061, 6332 and following ones)
3010 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003011}
3012
3013# Build and test a configuration where driver accelerates all EC algs while
3014# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3015# side.
3016#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003017# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3018component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003019 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003020
3021 # Algorithms and key types to accelerate
3022 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3023 ALG_ECDH \
3024 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003025 $(helper_get_psa_key_type_list "ECC") \
3026 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003027
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003028 # Configure
3029 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003030
Valerio Settie618cb02023-04-12 14:59:16 +02003031 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003032 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003033 # Disable all the builtin curves. All the required algs are accelerated.
3034 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003035
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003036 # Build
3037 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003038
3039 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003040 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3041 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3042 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003043
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003044 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003045
Valerio Setti3fe105b2023-10-30 11:08:12 +01003046 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003047
3048 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003049 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3050 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3051 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003052 # Also ensure that ECP module was not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003053 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003054
3055 # Run the tests
3056 # -------------
3057
Gilles Peskine14302ed2023-07-19 19:30:04 +02003058 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003059 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003060
Gilles Peskine14302ed2023-07-19 19:30:04 +02003061 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003062 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003063}
3064
3065# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003066# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003067# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003068component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003069 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003070
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003071 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003072
Gilles Peskine21570cf2023-12-22 11:49:50 +01003073 make
Valerio Settie618cb02023-04-12 14:59:16 +02003074
Gilles Peskine14302ed2023-07-19 19:30:04 +02003075 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003076 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003077
Gilles Peskine14302ed2023-07-19 19:30:04 +02003078 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003079 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003080}
3081
Valerio Setti4e2f2442023-08-15 10:10:26 +02003082# This is a common configuration helper used directly from:
3083# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3084# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3085# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003086# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003087# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003088# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003089# - this is the reference component of the above
3090# - it still disables RSA and FFDH, but it uses builtin EC algs
3091# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3092# - accelerate all EC and FFDH algs, disable only RSA
3093# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3094# - this is the reference component of the above
3095# - it still disables RSA, but it uses builtin EC and FFDH algs
3096#
3097# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003098# $1: a boolean value which states if we are testing an accelerated scenario
3099# or not.
3100# $2: a string value which states which components are tested. Allowed values
3101# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003102config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003103 driver_only="$1"
3104 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003105 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003106 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003107
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003108 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003109 # Disable modules that are accelerated
3110 scripts/config.py unset MBEDTLS_ECDSA_C
3111 scripts/config.py unset MBEDTLS_ECDH_C
3112 scripts/config.py unset MBEDTLS_ECJPAKE_C
3113 # Disable ECP module (entirely)
3114 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003115 # Also disable bignum
3116 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003117 fi
3118
3119 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3120 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3121 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3122 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3123
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003124 # RSA support is intentionally disabled on this test because RSA_C depends
3125 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003126 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3127 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 +02003128 scripts/config.py unset MBEDTLS_RSA_C
3129 scripts/config.py unset MBEDTLS_PKCS1_V15
3130 scripts/config.py unset MBEDTLS_PKCS1_V21
3131 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3132 # Also disable key exchanges that depend on RSA
3133 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3134 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3135 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3136 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3137 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3138
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003139 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003140 # When testing ECC only, we disable FFDH support, both from builtin and
3141 # PSA sides, and also disable the key exchanges that depend on DHM.
Ronald Cron7e5d61c2024-06-10 14:25:46 +02003142 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_FFDH
Valerio Setti4e2f2442023-08-15 10:10:26 +02003143 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 +01003144 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003145 scripts/config.py unset MBEDTLS_DHM_C
3146 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3147 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3148 else
3149 # When testing ECC and DH instead, we disable DHM and depending key
3150 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003151 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003152 scripts/config.py unset MBEDTLS_DHM_C
3153 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3154 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3155 fi
3156 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003157
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003158 # Restartable feature is not yet supported by PSA. Once it will in
3159 # the future, the following line could be removed (see issues
3160 # 6061, 6332 and following ones)
3161 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3162}
3163
Valerio Setti4e2f2442023-08-15 10:10:26 +02003164# Common helper used by:
3165# - component_test_psa_crypto_config_accel_ecc_no_bignum
3166# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003167#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003168# The goal is to build and test accelerating either:
3169# - ECC only or
3170# - both ECC and FFDH
3171#
3172# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003173# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3174# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003175common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003176 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003177
Valerio Setti5dfaca42023-09-05 08:48:51 +02003178 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003179 if [ "$test_target" = "ECC_DH" ]; then
3180 accel_text="ECC/FFDH"
3181 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003182 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003183 accel_text="ECC"
3184 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003185 fi
3186
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003187 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003188
3189 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003190 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3191 ALG_ECDH \
3192 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003193 $(helper_get_psa_key_type_list "ECC") \
3194 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003195 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003196 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003197 loc_accel_list="$loc_accel_list \
3198 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003199 $(helper_get_psa_key_type_list "DH") \
3200 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003201 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003202
3203 # Configure
3204 # ---------
3205
3206 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003207 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003208 # Disable all the builtin curves. All the required algs are accelerated.
3209 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003210
3211 # Build
3212 # -----
3213
3214 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003215 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3216 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3217 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003218
3219 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3220
Valerio Setti3fe105b2023-10-30 11:08:12 +01003221 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003222
3223 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003224 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3225 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3226 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003227 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003228 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3229 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3230 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
3231 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003232
3233 # Run the tests
3234 # -------------
3235
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003236 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003237
Gilles Peskine21570cf2023-12-22 11:49:50 +01003238 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003239
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003240 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003241 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003242}
3243
Valerio Setti4e2f2442023-08-15 10:10:26 +02003244# Common helper used by:
3245# - component_test_psa_crypto_config_reference_ecc_no_bignum
3246# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3247#
3248# The goal is to build and test a reference scenario (i.e. with builtin
3249# components) compared to the ones used in
3250# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3251#
3252# It is meant to be used in conjunction with
3253# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3254# coverage analysis in "analyze_outcomes.py" script.
3255common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003256 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003257
Valerio Setti5dfaca42023-09-05 08:48:51 +02003258 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003259 if [ "$test_target" = "ECC_DH" ]; then
3260 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003261 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003262 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003263 fi
3264
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003265 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003266
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003267 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003268
Gilles Peskine21570cf2023-12-22 11:49:50 +01003269 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003270
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003271 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003272 make test
3273
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003274 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003275 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003276}
3277
Valerio Setti4e2f2442023-08-15 10:10:26 +02003278component_test_psa_crypto_config_accel_ecc_no_bignum () {
3279 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3280}
3281
3282component_test_psa_crypto_config_reference_ecc_no_bignum () {
3283 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3284}
3285
3286component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3287 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3288}
3289
3290component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3291 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3292}
3293
Valerio Settiac6d35f2023-08-04 12:49:11 +02003294# Helper for setting common configurations between:
3295# - component_test_tfm_config_p256m_driver_accel_ec()
3296# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003297common_tfm_config () {
3298 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003299 cp configs/config-tfm.h "$CONFIG_H"
3300 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3301 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003302
Yanray Wang73bb2312023-09-25 11:21:15 +08003303 # Other config adjustment to make the tests pass.
3304 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003305 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003306 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3307 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003308
Yanray Wang73bb2312023-09-25 11:21:15 +08003309 # Config adjustment for better test coverage in our environment.
3310 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003311 #
3312 # Enable filesystem I/O for the benefit of PK parse/write tests.
3313 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3314}
3315
Valerio Settiac6d35f2023-08-04 12:49:11 +02003316# Keep this in sync with component_test_tfm_config() as they are both meant
3317# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003318component_test_tfm_config_p256m_driver_accel_ec () {
3319 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3320
3321 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003322
Dave Rodgman897bb772023-11-15 16:34:20 +00003323 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003324 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003325
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003326 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003327 not grep mbedtls_ecdsa_ ${BUILTIN_SRC_PATH}/ecdsa.o
3328 not grep mbedtls_ecdh_ ${BUILTIN_SRC_PATH}/ecdh.o
3329 not grep mbedtls_ecjpake_ ${BUILTIN_SRC_PATH}/ecjpake.o
Valerio Settib7e95442023-03-21 11:52:33 +01003330 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
Ronald Cron709bbf02024-07-03 07:59:30 +02003331 not grep mbedtls_ecp_ ${BUILTIN_SRC_PATH}/ecp.o
3332 not grep mbedtls_rsa_ ${BUILTIN_SRC_PATH}/rsa.o
3333 not grep mbedtls_dhm_ ${BUILTIN_SRC_PATH}/dhm.o
3334 not grep mbedtls_mpi_ ${BUILTIN_SRC_PATH}/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003335 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003336 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003337
Valerio Setti5e18b902023-12-04 12:07:30 +01003338 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3339 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003340 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003341
Valerio Settib7e95442023-03-21 11:52:33 +01003342 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003343 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003344 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003345}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003346
Valerio Settiac6d35f2023-08-04 12:49:11 +02003347# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3348# they are both meant to be used in analyze_outcomes.py for driver's coverage
3349# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003350component_test_tfm_config() {
3351 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003352
Dave Rodgman897bb772023-11-15 16:34:20 +00003353 # Disable P256M driver, which is on by default, so that analyze_outcomes
3354 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3355 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3356
Valerio Setti52ba0e32023-08-04 12:43:03 +02003357 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003358 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003359
Dave Rodgman897bb772023-11-15 16:34:20 +00003360 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003361 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003362
Valerio Setti5e18b902023-12-04 12:07:30 +01003363 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3364 # files, so we want to ensure that it has not be re-enabled accidentally.
Ronald Cron709bbf02024-07-03 07:59:30 +02003365 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
Valerio Setti5e18b902023-12-04 12:07:30 +01003366
Valerio Setti52ba0e32023-08-04 12:43:03 +02003367 msg "test: TF-M config"
3368 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003369}
3370
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003371# Common helper for component_full_without_ecdhe_ecdsa() and
3372# component_full_without_ecdhe_ecdsa_and_tls13() which:
3373# - starts from the "full" configuration minus the list of symbols passed in
3374# as 1st parameter
3375# - build
3376# - test only TLS (i.e. test_suite_tls and ssl-opt)
3377build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003378 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003379
3380 msg "build: full minus something, test TLS"
3381
3382 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003383 for sym in $symbols_to_disable; do
3384 echo "Disabling $sym"
3385 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003386 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003387
Gilles Peskine21570cf2023-12-22 11:49:50 +01003388 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003389
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003390 msg "test: full minus something, test TLS"
3391 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003392
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003393 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003394 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003395}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003396
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003397component_full_without_ecdhe_ecdsa () {
3398 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003399}
3400
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003401component_full_without_ecdhe_ecdsa_and_tls13 () {
3402 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3403 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003404}
3405
Valerio Setti249b18a2023-06-20 12:08:30 +02003406# This is an helper used by:
3407# - component_test_psa_ecc_key_pair_no_derive
3408# - component_test_psa_ecc_key_pair_no_generate
3409# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3410# enabled, but one. Input arguments are as follows:
3411# - $1 is the key type under test, i.e. ECC/RSA/DH
3412# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003413build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003414 key_type=$1
3415 unset_option=$2
3416 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003417
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003418 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003419 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003420 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3421 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3422
3423 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3424 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003425 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003426
Gilles Peskine21570cf2023-12-22 11:49:50 +01003427 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003428
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003429 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003430 make test
3431}
3432
3433component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003434 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003435}
3436
3437component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003438 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003439}
3440
Pengyu Lve705f572023-12-06 16:38:15 +08003441config_psa_crypto_accel_rsa () {
3442 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003443
Pengyu Lve705f572023-12-06 16:38:15 +08003444 # Start from crypto_full config (no X.509, no TLS)
3445 helper_libtestdriver1_adjust_config "crypto_full"
3446
3447 if [ "$driver_only" -eq 1 ]; then
3448 # Remove RSA support and its dependencies
3449 scripts/config.py unset MBEDTLS_RSA_C
3450 scripts/config.py unset MBEDTLS_PKCS1_V15
3451 scripts/config.py unset MBEDTLS_PKCS1_V21
3452
3453 # We need PEM parsing in the test library as well to support the import
3454 # of PEM encoded RSA keys.
3455 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3456 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3457 fi
3458}
3459
3460component_test_psa_crypto_config_accel_rsa_crypto () {
3461 msg "build: crypto_full with accelerated RSA"
3462
3463 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3464 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3465 KEY_TYPE_RSA_PUBLIC_KEY \
3466 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3467 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3468 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3469 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003470
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003471 # Configure
3472 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003473
Pengyu Lve705f572023-12-06 16:38:15 +08003474 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003475
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003476 # Build
3477 # -----
3478
Pengyu Lve705f572023-12-06 16:38:15 +08003479 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003480 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 +08003481 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003482 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003483
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003484 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003485
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003486 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003487 not grep mbedtls_rsa ${BUILTIN_SRC_PATH}/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003488
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003489 # Run the tests
3490 # -------------
3491
Pengyu Lve705f572023-12-06 16:38:15 +08003492 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003493 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003494}
3495
3496component_test_psa_crypto_config_reference_rsa_crypto () {
3497 msg "build: crypto_full with non-accelerated RSA"
3498
3499 # Configure
3500 # ---------
3501 config_psa_crypto_accel_rsa 0
3502
3503 # Build
3504 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003505 make
Pengyu Lve705f572023-12-06 16:38:15 +08003506
3507 # Run the tests
3508 # -------------
3509 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003510 make test
3511}
3512
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003513# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003514# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003515component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003516 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003517
Valerio Setti4590bc22023-06-13 15:39:23 +02003518 # Create a temporary output file unless there is already one set
3519 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3520 REMOVE_OUTCOME_ON_EXIT="no"
3521 else
3522 REMOVE_OUTCOME_ON_EXIT="yes"
3523 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3524 export MBEDTLS_TEST_OUTCOME_FILE
3525 fi
3526
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003527 # Start from crypto configuration
3528 scripts/config.py crypto
3529
3530 # Remove RSA support and its dependencies
3531 scripts/config.py unset MBEDTLS_PKCS1_V15
3532 scripts/config.py unset MBEDTLS_PKCS1_V21
3533 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3534 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3535 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3536 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3537 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3538 scripts/config.py unset MBEDTLS_RSA_C
3539 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3540
3541 # Enable PSA support
3542 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3543
Valerio Setti01cc88a2023-06-15 11:53:08 +02003544 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003545 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003546 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3547 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3548 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003549
3550 make
3551
Valerio Setti01cc88a2023-06-15 11:53:08 +02003552 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003553 make test
3554
3555 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3556 # performing RSA signature.
3557 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3558 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3559
3560 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3561 rm $MBEDTLS_TEST_OUTCOME_FILE
3562 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003563}
3564
Ronald Cronb2312452021-05-08 14:32:59 +02003565component_test_psa_crypto_config_accel_hash () {
3566 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3567
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003568 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3569 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3570 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003571
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003572 # Configure
3573 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003574
Ronald Cron46ac0652024-03-18 12:39:04 +01003575 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003576 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003577
3578 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003579 scripts/config.py unset MBEDTLS_MD5_C
3580 scripts/config.py unset MBEDTLS_RIPEMD160_C
3581 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003582 scripts/config.py unset MBEDTLS_SHA224_C
3583 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003584 scripts/config.py unset MBEDTLS_SHA384_C
3585 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003586 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003587
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003588 # Build
3589 # -----
3590
3591 helper_libtestdriver1_make_drivers "$loc_accel_list"
3592
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003593 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003594
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003595 # There's a risk of something getting re-enabled via config_psa.h;
3596 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003597 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3598 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3599 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3600 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3601 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003602
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003603 # Run the tests
3604 # -------------
3605
Ronald Cronb2312452021-05-08 14:32:59 +02003606 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3607 make test
3608}
3609
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003610# Auxiliary function to build config for hashes with and without drivers
3611config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003612 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003613 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003614 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003615 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003616 # disable the built-in implementation of hashes
3617 scripts/config.py unset MBEDTLS_MD5_C
3618 scripts/config.py unset MBEDTLS_RIPEMD160_C
3619 scripts/config.py unset MBEDTLS_SHA1_C
3620 scripts/config.py unset MBEDTLS_SHA224_C
3621 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003622 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003623 scripts/config.py unset MBEDTLS_SHA384_C
3624 scripts/config.py unset MBEDTLS_SHA512_C
3625 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003626 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003627 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003628}
3629
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003630# Note that component_test_psa_crypto_config_reference_hash_use_psa
3631# is related to this component and both components need to be kept in sync.
3632# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003633component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003634 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003635
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003636 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3637 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3638 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003639
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003640 # Configure
3641 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003642
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003643 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003644
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003645 # Build
3646 # -----
3647
3648 helper_libtestdriver1_make_drivers "$loc_accel_list"
3649
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003650 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003651
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003652 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003653 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003654 not grep mbedtls_md5 ${BUILTIN_SRC_PATH}/md5.o
3655 not grep mbedtls_sha1 ${BUILTIN_SRC_PATH}/sha1.o
3656 not grep mbedtls_sha256 ${BUILTIN_SRC_PATH}/sha256.o
3657 not grep mbedtls_sha512 ${BUILTIN_SRC_PATH}/sha512.o
3658 not grep mbedtls_ripemd160 ${BUILTIN_SRC_PATH}/ripemd160.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003659
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003660 # Run the tests
3661 # -------------
3662
Gilles Peskine14302ed2023-07-19 19:30:04 +02003663 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003664 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003665
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003666 # This is mostly useful so that we can later compare outcome files with
3667 # the reference config in analyze_outcomes.py, to check that the
3668 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003669 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003670 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003671
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003672 # This is to make sure all ciphersuites are exercised, but we don't need
3673 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003674 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003675 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003676}
3677
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003678# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3679# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3680# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3681# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003682component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003683 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003684
3685 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003686
Gilles Peskine21570cf2023-12-22 11:49:50 +01003687 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003688
Gilles Peskine14302ed2023-07-19 19:30:04 +02003689 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003690 make test
3691
Gilles Peskine14302ed2023-07-19 19:30:04 +02003692 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003693 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003694}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003695
Valerio Setti8eb310c2024-01-22 16:22:57 +01003696# Auxiliary function to build config for hashes with and without drivers
3697config_psa_crypto_hmac_use_psa () {
3698 driver_only="$1"
3699 # start with config full for maximum coverage (also enables USE_PSA)
3700 helper_libtestdriver1_adjust_config "full"
3701
Valerio Setticd89b0b2024-01-24 14:24:55 +01003702 if [ "$driver_only" -eq 1 ]; then
3703 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3704 # is still enabled though (for ENTROPY_C among others).
3705 scripts/config.py unset MBEDTLS_MD_C
3706 # Disable also the builtin hashes since they are supported by the driver
3707 # and MD module is able to perform PSA dispathing.
3708 scripts/config.py unset-all MBEDTLS_SHA
3709 scripts/config.py unset MBEDTLS_MD5_C
3710 scripts/config.py unset MBEDTLS_RIPEMD160_C
3711 fi
3712
Valerio Setti8eb310c2024-01-22 16:22:57 +01003713 # Direct dependencies of MD_C. We disable them also in the reference
3714 # component to work with the same set of features.
3715 scripts/config.py unset MBEDTLS_PKCS7_C
3716 scripts/config.py unset MBEDTLS_PKCS5_C
3717 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3718 scripts/config.py unset MBEDTLS_HKDF_C
3719 # Dependencies of HMAC_DRBG
3720 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3721 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3722}
3723
3724component_test_psa_crypto_config_accel_hmac() {
3725 msg "test: full with accelerated hmac"
3726
3727 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3728 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3729 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3730 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3731
3732 # Configure
3733 # ---------
3734
3735 config_psa_crypto_hmac_use_psa 1
3736
Valerio Setti8eb310c2024-01-22 16:22:57 +01003737 # Build
3738 # -----
3739
3740 helper_libtestdriver1_make_drivers "$loc_accel_list"
3741
3742 helper_libtestdriver1_make_main "$loc_accel_list"
3743
3744 # Ensure that built-in support for HMAC is disabled.
Ronald Cron709bbf02024-07-03 07:59:30 +02003745 not grep mbedtls_md_hmac ${BUILTIN_SRC_PATH}/md.o
Valerio Setti8eb310c2024-01-22 16:22:57 +01003746
3747 # Run the tests
3748 # -------------
3749
3750 msg "test: full with accelerated hmac"
3751 make test
3752}
3753
3754component_test_psa_crypto_config_reference_hmac() {
3755 msg "test: full without accelerated hmac"
3756
3757 config_psa_crypto_hmac_use_psa 0
3758
3759 make
3760
3761 msg "test: full without accelerated hmac"
3762 make test
3763}
3764
Valerio Setti9da01a72023-12-18 17:38:18 +01003765component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003766 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003767
Valerio Setti9da01a72023-12-18 17:38:18 +01003768 # Albeit this components aims at accelerating DES which should only support
3769 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3770 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003771 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3772 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3773 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003774
Valerio Setti9da01a72023-12-18 17:38:18 +01003775 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3776 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3777 # of this component. This limitation will be addressed by #8598.
3778
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003779 # Configure
3780 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003781
Valerio Setti9a427302023-10-17 11:40:42 +02003782 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003783 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003784
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003785 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003786 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3787 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3788 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3789 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3790 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3791 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3792 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003793 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003794
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003795 # Build
3796 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003797
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003798 helper_libtestdriver1_make_drivers "$loc_accel_list"
3799
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003800 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003801
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003802 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003803 not grep mbedtls_des* ${BUILTIN_SRC_PATH}/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003804
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003805 # Run the tests
3806 # -------------
3807
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003808 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003809 make test
3810}
3811
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003812component_test_psa_crypto_config_accel_aead () {
3813 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3814
Valerio Setti3f02bb72023-10-02 15:57:33 +02003815 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3816 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003817
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003818 # Configure
3819 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003820
Valerio Setti3f02bb72023-10-02 15:57:33 +02003821 # Start from full config
3822 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003823
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003824 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003825 scripts/config.py unset MBEDTLS_GCM_C
3826 scripts/config.py unset MBEDTLS_CCM_C
3827 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003828
Valerio Settia50b89e2023-11-08 15:58:47 +01003829 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3830 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003831
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003832 # Build
3833 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003834
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003835 helper_libtestdriver1_make_drivers "$loc_accel_list"
3836
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003837 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003838
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003839 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003840 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3841 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3842 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
Przemek Stekielee1bb412022-10-11 11:52:25 +02003843
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003844 # Run the tests
3845 # -------------
3846
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003847 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3848 make test
3849}
3850
Valerio Settib680fc42023-10-13 09:29:37 +02003851# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003852# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3853# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3854common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003855 # Start from the full config
3856 helper_libtestdriver1_adjust_config "full"
3857
Valerio Settib680fc42023-10-13 09:29:37 +02003858 scripts/config.py unset MBEDTLS_NIST_KW_C
3859}
3860
Valerio Settib6b301f2023-10-04 12:05:05 +02003861# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003862# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3863# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003864# are meant to be used together in analyze_outcomes.py script in order to test
3865# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003866component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3867 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003868
Valerio Settiad8b7f02023-10-25 12:39:50 +02003869 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 +01003870 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003871 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003872 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3873
3874 # Configure
3875 # ---------
3876
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003877 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003878
3879 # Disable the things that are being accelerated
3880 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3881 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3882 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3883 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3884 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3885 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3886 scripts/config.py unset MBEDTLS_GCM_C
3887 scripts/config.py unset MBEDTLS_CCM_C
3888 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003889 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003890 scripts/config.py unset MBEDTLS_DES_C
3891 scripts/config.py unset MBEDTLS_AES_C
3892 scripts/config.py unset MBEDTLS_ARIA_C
3893 scripts/config.py unset MBEDTLS_CHACHA20_C
3894 scripts/config.py unset MBEDTLS_CAMELLIA_C
3895
Valerio Settiec9b2582023-11-08 16:50:54 +01003896 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3897 # does not depend on it.
3898 scripts/config.py unset MBEDTLS_CIPHER_C
3899
Valerio Settib6b301f2023-10-04 12:05:05 +02003900 # Build
3901 # -----
3902
3903 helper_libtestdriver1_make_drivers "$loc_accel_list"
3904
3905 helper_libtestdriver1_make_main "$loc_accel_list"
3906
3907 # Make sure this was not re-enabled by accident (additive config)
Ronald Cron709bbf02024-07-03 07:59:30 +02003908 not grep mbedtls_cipher ${BUILTIN_SRC_PATH}/cipher.o
3909 not grep mbedtls_des ${BUILTIN_SRC_PATH}/des.o
3910 not grep mbedtls_aes ${BUILTIN_SRC_PATH}/aes.o
3911 not grep mbedtls_aria ${BUILTIN_SRC_PATH}/aria.o
3912 not grep mbedtls_camellia ${BUILTIN_SRC_PATH}/camellia.o
3913 not grep mbedtls_ccm ${BUILTIN_SRC_PATH}/ccm.o
3914 not grep mbedtls_gcm ${BUILTIN_SRC_PATH}/gcm.o
3915 not grep mbedtls_chachapoly ${BUILTIN_SRC_PATH}/chachapoly.o
3916 not grep mbedtls_cmac ${BUILTIN_SRC_PATH}/cmac.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003917
3918 # Run the tests
3919 # -------------
3920
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003921 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003922 make test
Valerio Settif9414552023-11-09 10:43:20 +01003923
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003924 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003925 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003926
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003927 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003928 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003929}
3930
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003931component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3932 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3933 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003934
Gilles Peskine21570cf2023-12-22 11:49:50 +01003935 make
Valerio Settif9414552023-11-09 10:43:20 +01003936
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003937 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003938 make test
Valerio Settif9414552023-11-09 10:43:20 +01003939
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003940 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003941 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003942
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003943 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003944 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003945}
3946
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003947common_block_cipher_dispatch() {
3948 TEST_WITH_DRIVER="$1"
3949
3950 # Start from the full config
3951 helper_libtestdriver1_adjust_config "full"
3952
3953 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3954 # Disable key types that are accelerated (there is no legacy equivalent
3955 # symbol for ECB)
3956 scripts/config.py unset MBEDTLS_AES_C
3957 scripts/config.py unset MBEDTLS_ARIA_C
3958 scripts/config.py unset MBEDTLS_CAMELLIA_C
3959 fi
3960
Valerio Setti8c8b4da2024-01-02 11:44:30 +01003961 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003962 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01003963 # Keep this also in the reference component in order to skip the same tests
3964 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003965 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
3966 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
3967 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
3968 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
3969 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
3970 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
3971 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02003972 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003973
3974 # Disable direct dependency on AES_C
3975 scripts/config.py unset MBEDTLS_NIST_KW_C
3976
3977 # Prevent the cipher module from using deprecated PSA path. The reason is
3978 # that otherwise there will be tests relying on "aes_info" (defined in
3979 # "cipher_wrap.c") whose functions are not available when AES_C is
3980 # not defined. ARIA and Camellia are not a problem in this case because
3981 # the PSA path is not tested for these key types.
3982 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
3983}
3984
Valerio Settif8e6cba2023-12-12 11:53:39 +01003985component_test_full_block_cipher_psa_dispatch () {
3986 msg "build: full + PSA dispatch in block_cipher"
3987
3988 loc_accel_list="ALG_ECB_NO_PADDING \
3989 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
3990
3991 # Configure
3992 # ---------
3993
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003994 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01003995
Valerio Settif8e6cba2023-12-12 11:53:39 +01003996 # Build
3997 # -----
3998
3999 helper_libtestdriver1_make_drivers "$loc_accel_list"
4000
4001 helper_libtestdriver1_make_main "$loc_accel_list"
4002
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004003 # Make sure disabled components were not re-enabled by accident (additive
4004 # config)
Ronald Cron709bbf02024-07-03 07:59:30 +02004005 not grep mbedtls_aes_ ${BUILTIN_SRC_PATH}/aes.o
4006 not grep mbedtls_aria_ ${BUILTIN_SRC_PATH}/aria.o
4007 not grep mbedtls_camellia_ ${BUILTIN_SRC_PATH}/camellia.o
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004008
Valerio Settif8e6cba2023-12-12 11:53:39 +01004009 # Run the tests
4010 # -------------
4011
4012 msg "test: full + PSA dispatch in block_cipher"
4013 make test
4014}
4015
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004016# This is the reference component of component_test_full_block_cipher_psa_dispatch
4017component_test_full_block_cipher_legacy_dispatch () {
4018 msg "build: full + legacy dispatch in block_cipher"
4019
4020 common_block_cipher_dispatch 0
4021
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004022 make
4023
4024 msg "test: full + legacy dispatch in block_cipher"
4025 make test
4026}
4027
Gilles Peskine36dea152023-07-20 22:19:45 +02004028component_test_aead_chachapoly_disabled() {
4029 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004030 scripts/config.py full
4031 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004032 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004033 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004034
Gilles Peskine36dea152023-07-20 22:19:45 +02004035 msg "test: full minus CHACHAPOLY"
4036 make test
4037}
4038
4039component_test_aead_only_ccm() {
4040 msg "build: full minus CHACHAPOLY and GCM"
4041 scripts/config.py full
4042 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4043 scripts/config.py unset MBEDTLS_GCM_C
4044 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4045 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004046 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004047
4048 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004049 make test
4050}
4051
Ronald Crone501d0e2023-07-10 08:31:19 +02004052component_test_ccm_aes_sha256() {
4053 msg "build: CCM + AES + SHA256 configuration"
4054
Ronald Cron7612d8c2023-07-20 10:03:54 +02004055 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004056 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004057
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004058 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004059
4060 msg "test: CCM + AES + SHA256 configuration"
4061 make test
4062}
4063
Dave Rodgman904c5892023-06-28 17:36:02 +01004064support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004065 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004066}
4067
Dave Rodgman904c5892023-06-28 17:36:02 +01004068component_build_tfm_armcc() {
4069 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004070 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004071
Dave Rodgman88651c42023-06-29 12:35:51 +01004072 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004073 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 +01004074}
4075
4076component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004077 # Check that the TF-M configuration can build cleanly with various
4078 # warning flags enabled. We don't build or run tests, since the
4079 # TF-M configuration needs a TF-M platform. A tweaked version of
4080 # the configuration that works on mainstream platforms is in
4081 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004082 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004083
Dave Rodgman88651c42023-06-29 12:35:51 +01004084 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004085 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 +01004086
Dave Rodgman904c5892023-06-28 17:36:02 +01004087 msg "build: TF-M config, gcc native build"
4088 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004089 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 +01004090}
4091
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004092# Test that the given .o file builds with all (valid) combinations of the given options.
4093#
4094# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4095#
4096# The validator function is the name of a function to validate the combination of options.
4097# It may be "" if all combinations are valid.
4098# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004099# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004100build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004101 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004102 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004103 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004104 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004105 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004106
Dave Rodgman42436102023-10-03 15:47:05 +01004107 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004108 for opt in "${options[@]}"; do
4109 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004110 done
4111
Ronald Cron709bbf02024-07-03 07:59:30 +02004112 # enter the library directory
4113 cd library
Dave Rodgman42436102023-10-03 15:47:05 +01004114
Dave Rodgman920343a2023-10-01 18:41:09 +01004115 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004116 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 +01004117
Dave Rodgman42436102023-10-03 15:47:05 +01004118 # Extract the command generated by the Makefile to build the target file.
4119 # This ensures that we have any include paths, macro definitions, etc
4120 # that may be applied by make.
4121 # 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 +01004122 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004123
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004124 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004125 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004126
Dave Rodgman28e38d82023-10-04 11:50:30 +01004127 len=${#options[@]}
Ronald Cron709bbf02024-07-03 07:59:30 +02004128 source_file=../${file%.o}.c
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004129
4130 targets=0
4131 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004132
Dave Rodgman28e38d82023-10-04 11:50:30 +01004133 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004134 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004135 # each bit of $i is used to determine if options[i] will be set or not
4136 target="t"
4137 clang_args=""
4138 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004139 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004140 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004141 clang_args="${clang_args} ${opt}"
4142 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004143 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004144 done
4145
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004146 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004147 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004148 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004149 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004150
Dave Rodgman28e38d82023-10-04 11:50:30 +01004151 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004152 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004153 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004154 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004155
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004156 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004157
Dave Rodgman920343a2023-10-01 18:41:09 +01004158 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004159 make -s -f ${makefile} build_test_config_combos
4160 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004161
4162 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004163 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004164}
4165
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004166validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004167 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
Dave Rodgman920343a2023-10-01 18:41:09 +01004168 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4169 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004170 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004171 fi
4172 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004173 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004174}
4175
4176component_build_aes_variations() {
4177 # 18s - around 90ms per clang invocation on M1 Pro
4178 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004179 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004180 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004181
Yanray Wangbc29aef2023-11-06 11:08:17 +08004182 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004183 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004184
Ronald Cron709bbf02024-07-03 07:59:30 +02004185 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004186 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4187 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004188 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Dave Rodgman920343a2023-10-01 18:41:09 +01004189 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004190
4191 cd "$MBEDTLS_ROOT_DIR"
4192 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4193
Yanray Wang42be1ba2023-11-23 14:28:47 +08004194 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004195 # manually set or unset those configurations to check
4196 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004197 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4198 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4199 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4200 scripts/config.py unset MBEDTLS_DES_C
4201 scripts/config.py unset MBEDTLS_NIST_KW_C
Ronald Cron709bbf02024-07-03 07:59:30 +02004202 build_test_config_combos ${BUILTIN_SRC_PATH}/aes.o validate_aes_config_variations \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004203 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4204 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
Thomas Daubney62af02c2024-06-14 10:37:13 +01004205 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
Yanray Wangbc29aef2023-11-06 11:08:17 +08004206 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004207}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004208
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004209component_test_no_platform () {
4210 # Full configuration build, without platform support, file IO and net sockets.
4211 # This should catch missing mbedtls_printf definitions, and by disabling file
4212 # IO, it should catch missing '#include <stdio.h>'
4213 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004214 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004215 scripts/config.py unset MBEDTLS_PLATFORM_C
4216 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004217 scripts/config.py unset MBEDTLS_FS_IO
4218 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004219 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004220 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004221 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004222 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004223 # to re-enable platform integration features otherwise disabled in C99 builds
4224 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004225 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004226}
Gilles Peskine7c652162017-12-11 00:01:40 +01004227
4228component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004229 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004230 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4231 scripts/config.py full
4232 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004233 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4234 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4235 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4236 make
4237}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004238
Gilles Peskine8f073122018-11-27 15:58:47 +01004239component_build_no_ssl_srv () {
4240 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004241 scripts/config.py full
4242 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004243 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004244}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004245
Gilles Peskine8f073122018-11-27 15:58:47 +01004246component_build_no_ssl_cli () {
4247 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004248 scripts/config.py full
4249 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004250 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004251}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004252
Gilles Peskine8f073122018-11-27 15:58:47 +01004253component_build_no_sockets () {
4254 # Note, C99 compliance can also be tested with the sockets support disabled,
4255 # as that requires a POSIX platform (which isn't the same as C99).
4256 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004257 scripts/config.py full
4258 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4259 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4260 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4261}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004262
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004263component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004264 msg "build: default config with memory buffer allocator and backtrace enabled"
4265 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4266 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4267 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004268 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004269 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004270 make
4271
4272 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4273 make test
4274}
4275
4276component_test_memory_buffer_allocator () {
4277 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004278 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4279 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004280 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004281 make
4282
4283 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4284 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004285
4286 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4287 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004288 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004289}
4290
Gilles Peskine8f073122018-11-27 15:58:47 +01004291component_test_no_max_fragment_length () {
4292 # Run max fragment length tests with MFL disabled
4293 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004294 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004295 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004296 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004297
Gilles Peskine8f073122018-11-27 15:58:47 +01004298 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004299 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004300}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004301
Hanno Becker545ced42019-02-19 11:10:48 +00004302component_test_asan_remove_peer_certificate () {
4303 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004304 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004305 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004306 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004307 make
4308
4309 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4310 make test
4311
4312 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004313 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004314
4315 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004316 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004317
4318 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004319 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004320}
4321
Gilles Peskine8f073122018-11-27 15:58:47 +01004322component_test_no_max_fragment_length_small_ssl_out_content_len () {
4323 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004324 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4325 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4326 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004327 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004328 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004329
Gilles Peskine8f073122018-11-27 15:58:47 +01004330 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004331 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004332
4333 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004334 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004335}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004336
Darryl Greenaad82f92019-12-02 10:53:11 +00004337component_test_variable_ssl_in_out_buffer_len () {
4338 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4339 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004340 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004341 make
4342
4343 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4344 make test
4345
4346 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004347 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004348
4349 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004350 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004351}
4352
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004353component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004354 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004355 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004356
Dave Rodgman17127e92023-12-14 16:42:48 +00004357 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004358 make
4359
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004360 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004361 make test
4362
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004363 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004364 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004365
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004366 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004367 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004368}
4369
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004370component_test_ssl_alloc_buffer_and_mfl () {
4371 msg "build: default config with memory buffer allocator and MFL extension"
4372 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4373 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4374 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4375 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4376 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004377 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004378 make
4379
4380 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4381 make test
4382
4383 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 +02004384 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004385}
4386
Gilles Peskine636c26a2020-03-04 20:46:15 +01004387component_test_when_no_ciphersuites_have_mac () {
4388 msg "build: when no ciphersuites have MAC"
Ronald Cron0417a2c2024-05-24 14:22:11 +02004389 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4390 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4391 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4392 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4393 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
4394
Gilles Peskine636c26a2020-03-04 20:46:15 +01004395 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004396 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004397 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron0417a2c2024-05-24 14:22:11 +02004398
Gilles Peskine636c26a2020-03-04 20:46:15 +01004399 make
4400
Ronald Croncd33cd62024-05-27 08:14:27 +02004401 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004402 make test
4403
Ronald Croncd33cd62024-05-27 08:14:27 +02004404 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004405 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004406}
4407
Raoul Strackxa4e86142020-06-15 17:03:13 +02004408component_test_no_date_time () {
4409 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4410 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004411 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004412 make
4413
4414 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4415 make test
4416}
4417
Gilles Peskine8f073122018-11-27 15:58:47 +01004418component_test_platform_calloc_macro () {
4419 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004420 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4421 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4422 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004423 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004424 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004425
Gilles Peskine8f073122018-11-27 15:58:47 +01004426 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4427 make test
4428}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004429
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004430component_test_malloc_0_null () {
4431 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004432 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004433 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 +02004434
4435 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4436 make test
4437
4438 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4439 # Just the calloc selftest. "make test" ran the others as part of the
4440 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004441 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004442
4443 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4444 # Run a subset of the tests. The choice is a balance between coverage
4445 # and time (including time indirectly wasted due to flaky tests).
4446 # The current choice is to skip tests whose description includes
4447 # "proxy", which is an approximation of skipping tests that use the
4448 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004449 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004450}
4451
Dave Rodgman6a08b682023-06-19 11:51:33 +01004452support_test_aesni() {
4453 # Check that gcc targets x86_64 (we can build AESNI), and check for
4454 # AESNI support on the host (we can run AESNI).
4455 #
4456 # The name of this function is possibly slightly misleading, but needs to align
4457 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004458 #
4459 # In principle 32-bit x86 can support AESNI, but our implementation does not
4460 # support 32-bit x86, so we check for x86-64.
4461 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004462 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4463 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004464 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004465}
4466
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004467component_test_aesni () { # ~ 60s
4468 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4469 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4470 #
4471 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4472 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4473 # exercise the plain C impl).
4474
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004475 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004476 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004477 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004478 scripts/config.py set MBEDTLS_HAVE_ASM
4479
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004480 # test the intrinsics implementation
4481 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004482 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004483 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004484 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004485 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004486
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004487 # test the asm implementation
4488 msg "AES tests, test assembly"
4489 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004490 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004491 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004492 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004493
4494 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004495 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004496 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004497 msg "AES tests, plain C"
4498 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004499 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004500 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004501 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004502 not grep -q "AES note: using AESNI" ./programs/test/selftest
4503 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004504
4505 # test the intrinsics implementation
4506 scripts/config.py set MBEDTLS_AESNI_C
4507 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4508 msg "AES tests, test AESNI only"
4509 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004510 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004511 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4512 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004513 grep -q "AES note: using AESNI" ./programs/test/selftest
4514 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004515}
4516
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004517component_test_sha3_variations() {
4518 msg "sha3 loop unroll variations"
4519
4520 # define minimal config sufficient to test SHA3
4521 cat > include/mbedtls/mbedtls_config.h << END
4522 #define MBEDTLS_SELF_TEST
4523 #define MBEDTLS_SHA3_C
4524END
4525
4526 msg "all loops unrolled"
4527 make clean
Ronald Cron635a2be2024-07-12 14:30:16 +02004528 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"
4529 ./tf-psa-crypto/tests/test_suite_shax
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004530
4531 msg "all loops rolled up"
4532 make clean
Ronald Cron635a2be2024-07-12 14:30:16 +02004533 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"
4534 ./tf-psa-crypto/tests/test_suite_shax
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004535}
4536
Jerry Yub6d39c22023-08-16 15:11:48 +08004537support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004538 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004539}
4540
4541component_test_aesni_m32 () { # ~ 60s
4542 # This tests are duplicated from component_test_aesni for i386 target
4543 #
4544 # AESNI intrinsic code supports i386 and assembly code does not support it.
4545
4546 msg "build: default config with different AES implementations"
4547 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004548 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4549 scripts/config.py set MBEDTLS_HAVE_ASM
4550
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004551 # test the intrinsics implementation with gcc
4552 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004553 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004554 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004555 # check that we built intrinsics - this should be used by default when supported by the compiler
4556 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4557 grep -q "AES note: using AESNI" ./programs/test/selftest
4558 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004559 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4560
4561 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004562 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4563 msg "AES tests, test AESNI only"
4564 make clean
4565 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4566 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4567 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4568 grep -q "AES note: using AESNI" ./programs/test/selftest
4569 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yub6d39c22023-08-16 15:11:48 +08004570 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4571}
4572
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004573support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004574 # clang >= 4 is required to build with target attributes
4575 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004576}
4577
4578component_test_aesni_m32_clang() {
4579
4580 scripts/config.py set MBEDTLS_AESNI_C
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004581 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4582 scripts/config.py set MBEDTLS_HAVE_ASM
4583
4584 # test the intrinsics implementation with clang
4585 msg "AES tests, test intrinsics (clang)"
4586 make clean
4587 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4588 # check that we built intrinsics - this should be used by default when supported by the compiler
4589 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4590 grep -q "AES note: using AESNI" ./programs/test/selftest
4591 grep -q "AES note: built-in implementation." ./programs/test/selftest
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004592 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4593}
4594
Jerry Yu193cbc02023-08-03 17:06:29 +08004595# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4596component_build_aes_aesce_armcc () {
4597 msg "Build: AESCE test on arm64 platform without plain C."
4598 scripts/config.py baremetal
4599
4600 # armc[56] don't support SHA-512 intrinsics
4601 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4602
4603 # Stop armclang warning about feature detection for A64_CRYPTO.
4604 # With this enabled, the library does build correctly under armclang,
4605 # but in baremetal builds (as tested here), feature detection is
4606 # unavailable, and the user is notified via a #warning. So enabling
4607 # this feature would prevent us from building with -Werror on
4608 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004609 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004610 scripts/config.py set MBEDTLS_HAVE_ASM
4611
4612 msg "AESCE, build with default configuration."
4613 scripts/config.py set MBEDTLS_AESCE_C
4614 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4615 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4616
4617 msg "AESCE, build AESCE only"
4618 scripts/config.py set MBEDTLS_AESCE_C
4619 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4620 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4621}
4622
Dave Rodgman0c584032023-10-08 12:26:54 +01004623support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004624 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004625 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004626}
4627
4628component_build_aes_armce () {
4629 # Test variations of AES with Armv8 crypto extensions
4630 scripts/config.py set MBEDTLS_AESCE_C
4631 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4632
4633 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004634 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 +01004635
4636 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004637 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004638
4639 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004640 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 +01004641
Dave Rodgman5e419372023-10-23 15:30:20 +01004642 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004643
Dave Rodgman5e419372023-10-23 15:30:20 +01004644 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004645 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 +01004646
Dave Rodgman5e419372023-10-23 15:30:20 +01004647 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
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-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004649
Dave Rodgman5e419372023-10-23 15:30:20 +01004650 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004651 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 +01004652
4653 # test for presence of AES instructions
4654 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4655 msg "clang, test A32 crypto instructions built"
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 -S"
4657 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004658 msg "clang, test T32 crypto instructions built"
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 -S"
4660 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004661 msg "clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004662 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4663 grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004664
4665 # test for absence of AES instructions
4666 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4667 scripts/config.py unset MBEDTLS_AESCE_C
4668 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004669 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4670 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004671 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004672 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4673 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004674 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004675 make -B library/../${BUILTIN_SRC_PATH}/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4676 not grep -E 'aes[a-z]+\s*[qv]' ${BUILTIN_SRC_PATH}/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004677}
4678
Dave Rodgman9ed18532023-10-05 00:06:47 +01004679support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004680 # clang >= 4 is required to build with SHA extensions
4681 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004682}
4683
Dave Rodgmand9e80832023-10-04 17:17:46 +01004684component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004685 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004686
4687
4688 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004689 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004690 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004691 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004692 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004693 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 +01004694 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004695
Dave Rodgmand9e80832023-10-04 17:17:46 +01004696
Dave Rodgman94a634d2023-10-10 12:59:29 +01004697 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004698 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004699 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004700 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004701 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004702
Dave Rodgman5b89c552023-10-10 14:59:02 +01004703 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004704 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
Ronald Cron709bbf02024-07-03 07:59:30 +02004705 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 +01004706 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004707
Dave Rodgmancd654002023-10-05 09:40:07 +01004708
Dave Rodgman94a634d2023-10-10 12:59:29 +01004709 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004710 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004711 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
Ronald Cron709bbf02024-07-03 07:59:30 +02004712 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004713 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
Ronald Cron709bbf02024-07-03 07:59:30 +02004714 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 +01004715 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004716
Dave Rodgmancd654002023-10-05 09:40:07 +01004717
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004718 # examine the disassembly for presence of SHA instructions
4719 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4720 scripts/config.py set ${opt}
4721 msg "${opt} clang, test A32 crypto instructions built"
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-a72+crypto -marm -S"
4723 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004724
4725 msg "${opt} clang, test T32 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004726 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4727 grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004728
4729 msg "${opt} clang, test aarch64 crypto instructions built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004730 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4731 grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004732 scripts/config.py unset ${opt}
4733 done
4734
4735
4736 # examine the disassembly for absence of SHA instructions
4737 msg "clang, test A32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004738 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4739 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004740
4741 msg "clang, test T32 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004742 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4743 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004744
4745 msg "clang, test aarch64 crypto instructions not built"
Ronald Cron709bbf02024-07-03 07:59:30 +02004746 make -B library/../${BUILTIN_SRC_PATH}/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4747 not grep -E 'sha256[a-z0-9]+\s+[qv]' ${BUILTIN_SRC_PATH}/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004748}
4749
Jerry Yu193cbc02023-08-03 17:06:29 +08004750support_build_aes_aesce_armcc () {
4751 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004752}
4753
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004754component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004755 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004756 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Hanno Becker83ebf782017-07-07 12:29:15 +01004757
Dave Rodgmand8d64512023-12-19 12:20:21 +00004758 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004759
4760 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4761 make test
4762}
4763
4764component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4765 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4766 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004767 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004768
Hanno Becker83ebf782017-07-07 12:29:15 +01004769 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004770
4771 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004772 make test
4773}
Gilles Peskine8f073122018-11-27 15:58:47 +01004774
Hanno Becker83ebf782017-07-07 12:29:15 +01004775component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004776 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4777 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004778 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004779 scripts/config.py unset MBEDTLS_AESCE_C
4780
Dave Rodgmand8d64512023-12-19 12:20:21 +00004781 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004782
4783 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004784 make test
4785
4786 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4787 programs/test/selftest
4788}
4789
Matthias Schulz0767fda2024-02-07 10:46:28 +01004790component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004791 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4792 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004793 scripts/config.py unset MBEDTLS_AESNI_C
4794 scripts/config.py unset MBEDTLS_AESCE_C
4795
4796 make CFLAGS='-O2 -Werror -Wall -Wextra'
4797
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004798 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004799 make test
4800}
4801
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004802component_test_aes_fewer_tables () {
4803 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004804 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004805 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004806
Gilles Peskine7c652162017-12-11 00:01:40 +01004807 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004808 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004809}
4810
4811component_test_aes_rom_tables () {
4812 msg "build: default config with AES_ROM_TABLES enabled"
4813 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004814 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004815
4816 msg "test: AES_ROM_TABLES"
4817 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004818}
4819
Gilles Peskine14c3c062018-01-29 21:25:12 +01004820component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004821 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4822 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4823 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004824 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004825
Gilles Peskine8f073122018-11-27 15:58:47 +01004826 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4827 make test
4828}
4829
Yanray Wang49cd4b52023-11-10 11:58:37 +08004830# helper for common_block_cipher_no_decrypt() which:
4831# - enable/disable the list of config options passed from -s/-u respectively.
4832# - build
4833# - test for tests_suite_xxx
4834# - selftest
4835#
4836# Usage: helper_block_cipher_no_decrypt_build_test
4837# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4838# Options: -s set_opts the list of config options to enable
4839# -u unset_opts the list of config options to disable
4840# -c cflags the list of options passed to CFLAGS
4841# -l ldflags the list of options passed to LDFLAGS
4842helper_block_cipher_no_decrypt_build_test () {
4843 while [ $# -gt 0 ]; do
4844 case "$1" in
4845 -s)
4846 shift; local set_opts="$1";;
4847 -u)
4848 shift; local unset_opts="$1";;
4849 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004850 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004851 -l)
4852 shift; local ldflags="$1";;
4853 esac
4854 shift
4855 done
4856 set_opts="${set_opts:-}"
4857 unset_opts="${unset_opts:-}"
4858 cflags="${cflags:-}"
4859 ldflags="${ldflags:-}"
4860
Yanray Wangb2d6e522023-11-13 16:57:47 +08004861 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4862 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004863
4864 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4865 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004866 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004867
4868 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004869 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4870 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4871 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004872 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004873 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004874 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
Ronald Cron709bbf02024-07-03 07:59:30 +02004875 not grep mbedtls_aesni_inverse_key ${BUILTIN_SRC_PATH}/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004876
4877 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4878 make test
4879
4880 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4881 programs/test/selftest
4882}
4883
4884# This is a common configuration function used in:
4885# - component_test_block_cipher_no_decrypt_aesni_legacy()
4886# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4887# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4888# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4889# on x86.
4890common_block_cipher_no_decrypt () {
4891 # test AESNI intrinsics
4892 helper_block_cipher_no_decrypt_build_test \
4893 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004894 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004895
4896 # test AESNI assembly
4897 helper_block_cipher_no_decrypt_build_test \
4898 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004899 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004900
4901 # test AES C implementation
4902 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004903 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004904
4905 # test AESNI intrinsics for i386 target
4906 helper_block_cipher_no_decrypt_build_test \
4907 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004908 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004909 -l "-m32"
4910}
4911
Yanray Wang3ae11992023-11-13 17:32:09 +08004912# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4913# usage: 0: no PSA crypto configuration
4914# 1: use PSA crypto configuration
4915config_block_cipher_no_decrypt () {
4916 use_psa=$1
4917
Yanray Wang66111392023-10-31 18:54:54 +08004918 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004919 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4920 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004921 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004922 scripts/config.py unset MBEDTLS_NIST_KW_C
4923
Yanray Wang3ae11992023-11-13 17:32:09 +08004924 if [ "$use_psa" -eq 1 ]; then
4925 # Enable support for cryptographic mechanisms through the PSA API.
4926 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4927 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4928 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4929 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4930 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4931 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4932 fi
4933}
4934
4935component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004936 # This consistently causes an llvm crash on clang 3.8, so use gcc
4937 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004938 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08004939 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004940}
4941
Yanray Wangf1496402023-11-01 18:55:13 +08004942component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00004943 # This consistently causes an llvm crash on clang 3.8, so use gcc
4944 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08004945 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08004946 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08004947}
4948
Yanray Wang66111392023-10-31 18:54:54 +08004949support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004950 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08004951}
4952
Yanray Wang66111392023-10-31 18:54:54 +08004953component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08004954 scripts/config.py baremetal
4955
4956 # armc[56] don't support SHA-512 intrinsics
4957 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4958
4959 # Stop armclang warning about feature detection for A64_CRYPTO.
4960 # With this enabled, the library does build correctly under armclang,
4961 # but in baremetal builds (as tested here), feature detection is
4962 # unavailable, and the user is notified via a #warning. So enabling
4963 # this feature would prevent us from building with -Werror on
4964 # armclang. Tracked in #7198.
4965 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4966 scripts/config.py set MBEDTLS_HAVE_ASM
4967
Yanray Wang3ae11992023-11-13 17:32:09 +08004968 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08004969
4970 # test AESCE baremetal build
4971 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08004972 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08004973 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08004974
Yanray Wangef1b04d2023-09-08 11:09:26 +08004975 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
Ronald Cron709bbf02024-07-03 07:59:30 +02004976 not grep mbedtls_aes_setkey_dec ${BUILTIN_SRC_PATH}/aes.o
4977 not grep mbedtls_aria_setkey_dec ${BUILTIN_SRC_PATH}/aria.o
4978 not grep mbedtls_camellia_setkey_dec ${BUILTIN_SRC_PATH}/camellia.o
Yanray Wangef1b04d2023-09-08 11:09:26 +08004979 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
Ronald Cron709bbf02024-07-03 07:59:30 +02004980 not grep mbedtls_internal_aes_decrypt ${BUILTIN_SRC_PATH}/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004981 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Ronald Cron709bbf02024-07-03 07:59:30 +02004982 not grep mbedtls_aesce_inverse_key ${BUILTIN_SRC_PATH}/aesce.o
4983 not grep aesce_decrypt_block ${BUILTIN_SRC_PATH}/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08004984}
4985
Gilles Peskine592f5912019-10-07 18:49:32 +02004986component_test_ctr_drbg_aes_256_sha_256 () {
4987 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4988 scripts/config.py full
4989 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4990 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00004991 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02004992 make
4993
4994 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4995 make test
4996}
4997
4998component_test_ctr_drbg_aes_128_sha_512 () {
4999 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005000 scripts/config.py full
5001 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5002 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005003 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005004 make
5005
5006 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5007 make test
5008}
5009
5010component_test_ctr_drbg_aes_128_sha_256 () {
5011 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005012 scripts/config.py full
5013 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5014 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5015 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005016 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005017 make
5018
5019 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5020 make test
5021}
5022
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005023component_test_se_default () {
5024 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005025 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005026 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005027
5028 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5029 make test
5030}
5031
Steven Cooremand57203d2020-07-16 20:28:59 +02005032component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005033 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005034 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005035 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005036 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5037 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005038 loc_cflags="${loc_cflags} -I../tests/include -O2"
5039
Gilles Peskine21570cf2023-12-22 11:49:50 +01005040 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005041
Gilles Peskine1997f302023-07-26 18:45:20 +02005042 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005043 make test
5044}
5045
Gilles Peskine8f073122018-11-27 15:58:47 +01005046component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005047 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005048 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005049 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005050 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005051}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005052
Gilles Peskinecf740502019-07-03 20:43:05 +02005053component_test_cmake_shared () {
5054 msg "build/test: cmake shared" # ~ 2min
5055 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5056 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005057 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005058 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005059 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005060}
5061
Gilles Peskineec10bf12019-09-20 19:56:06 +02005062test_build_opt () {
5063 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005064 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005065 for opt in "$@"; do
5066 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005067 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005068 # We're confident enough in compilers to not run _all_ the tests,
5069 # but at least run the unit tests. In particular, runs with
5070 # optimizations use inline assembly whereas runs with -O0
5071 # skip inline assembly.
5072 make test # ~30s
5073 make clean
5074 done
5075}
5076
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005077# For FreeBSD we invoke the function by name so this condition is added
5078# to disable the existing test_clang_opt function for linux.
5079if [[ $(uname) != "Linux" ]]; then
5080 component_test_clang_opt () {
5081 scripts/config.py full
5082 test_build_opt 'full config' clang -O0 -Os -O2
5083 }
5084fi
5085
5086component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005087 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005088 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005089}
5090support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005091 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005092}
5093
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005094component_test_clang_earliest_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_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005097}
5098support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005099 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005100}
5101
5102component_test_gcc_latest_opt () {
5103 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005104 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005105}
5106support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005107 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005108}
5109
5110component_test_gcc_earliest_opt () {
5111 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005112 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005113}
5114support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005115 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005116}
5117
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005118component_build_mbedtls_config_file () {
5119 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005120 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005121 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005122 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005123 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005124 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5125 make clean
5126
5127 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5128 # In the user config, disable one feature (for simplicity, pick a feature
5129 # that nothing else depends on).
5130 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005131 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005132 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5133
5134 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005135}
5136
Gilles Peskine7d904e72022-04-07 21:59:14 +02005137component_build_psa_config_file () {
5138 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5139 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5140 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5141 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5142 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005143 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005144 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5145 make clean
5146
5147 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005148 # In the user config, disable one feature and its dependencies, which will
5149 # reflect on the mbedtls configuration so we can query it with
5150 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005151 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005152 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005153 scripts/config.py unset MBEDTLS_CMAC_C
5154 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5155 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5156
5157 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005158}
5159
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005160component_build_psa_alt_headers () {
5161 msg "build: make with PSA alt headers" # ~20s
5162
5163 # Generate alternative versions of the substitutable headers with the
5164 # same content except different include guards.
5165 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5166
5167 # Build the library and some programs.
5168 # Don't build the fuzzers to avoid having to go through hoops to set
5169 # a correct include path for programs/fuzz/Makefile.
5170 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
5171 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\"'"
5172
5173 # Check that we're getting the alternative include guards and not the
5174 # original include guards.
5175 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5176 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5177 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5178 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5179}
5180
Dave Rodgman852de3c2023-12-14 14:46:45 +00005181component_test_m32_no_asm () {
5182 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005183 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005184 #
5185 # Note that we require gcc, because clang Asan builds fail to link for
5186 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005187 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005188 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005189 scripts/config.py unset MBEDTLS_HAVE_ASM
Pengyu Lv13226132023-10-16 14:03:29 +08005190 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005191 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005192
Dave Rodgman852de3c2023-12-14 14:46:45 +00005193 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005194 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005195}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005196support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005197 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005198 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005199 *) false;;
5200 esac
5201}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005202
Gilles Peskineff0aee02021-10-05 09:36:03 +02005203component_test_m32_o2 () {
5204 # Build with optimization, to use the i386 specific inline assembly
5205 # and go faster for tests.
5206 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005207 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005208 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005209 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005210
Gilles Peskineff0aee02021-10-05 09:36:03 +02005211 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005212 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005213
Gilles Peskineff0aee02021-10-05 09:36:03 +02005214 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005215 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005216}
Gilles Peskinecf522222021-10-07 19:25:29 +02005217support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005218 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005219}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005220
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005221component_test_m32_everest () {
5222 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005223 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005224 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005225 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005226
5227 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5228 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005229
5230 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005231 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005232
5233 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5234 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005235 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005236}
5237support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005238 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005239}
5240
Gilles Peskine8f073122018-11-27 15:58:47 +01005241component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005242 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005243 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005244 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005245
5246 msg "test: 64-bit ILP32, make, gcc"
5247 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005248}
Gilles Peskine878cf602019-01-06 20:50:38 +00005249support_test_mx32 () {
5250 case $(uname -m) in
5251 amd64|x86_64) true;;
5252 *) false;;
5253 esac
5254}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005255
Peter Kolbus60c6da22018-12-27 06:59:04 -06005256component_test_min_mpi_window_size () {
5257 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005258 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005259 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005260 make
5261
5262 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5263 make test
5264}
5265
Gilles Peskine8f073122018-11-27 15:58:47 +01005266component_test_have_int32 () {
5267 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005268 scripts/config.py unset MBEDTLS_HAVE_ASM
5269 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005270 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005271 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005272
Gilles Peskine8f073122018-11-27 15:58:47 +01005273 msg "test: gcc, force 32-bit bignum limbs"
5274 make test
5275}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005276
Gilles Peskine8f073122018-11-27 15:58:47 +01005277component_test_have_int64 () {
5278 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005279 scripts/config.py unset MBEDTLS_HAVE_ASM
5280 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005281 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005282 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005283
Gilles Peskine8f073122018-11-27 15:58:47 +01005284 msg "test: gcc, force 64-bit bignum limbs"
5285 make test
5286}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005287
Gabor Mezeie256cc12023-07-26 17:28:48 +02005288component_test_have_int32_cmake_new_bignum () {
5289 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5290 scripts/config.py unset MBEDTLS_HAVE_ASM
5291 scripts/config.py unset MBEDTLS_AESNI_C
Gabor Mezeie256cc12023-07-26 17:28:48 +02005292 scripts/config.py unset MBEDTLS_AESCE_C
5293 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005294 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005295 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005296
5297 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5298 make test
5299}
5300
Gilles Peskine8f073122018-11-27 15:58:47 +01005301component_test_no_udbl_division () {
5302 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005303 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005304 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005305 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005306
Gilles Peskine8f073122018-11-27 15:58:47 +01005307 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5308 make test
5309}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005310
Gilles Peskine8f073122018-11-27 15:58:47 +01005311component_test_no_64bit_multiplication () {
5312 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005313 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005314 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005315 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005316
Gilles Peskine8f073122018-11-27 15:58:47 +01005317 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5318 make test
5319}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005320
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005321component_test_no_strings () {
5322 msg "build: no strings" # ~10s
5323 scripts/config.py full
5324 # Disable options that activate a large amount of string constants.
5325 scripts/config.py unset MBEDTLS_DEBUG_C
5326 scripts/config.py unset MBEDTLS_ERROR_C
5327 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5328 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005329 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005330
5331 msg "test: no strings" # ~ 10s
5332 make test
5333}
5334
Hanno Beckerc5722d12020-10-09 11:10:42 +01005335component_test_no_x509_info () {
5336 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5337 scripts/config.pl full
5338 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5339 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005340 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005341
5342 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5343 make test
5344
5345 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005346 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005347}
5348
Gilles Peskine8f073122018-11-27 15:58:47 +01005349component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005350 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005351 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005352 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 +02005353
Gilles Peskinee36fe812021-09-01 20:00:33 +02005354 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005355 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005356 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005357 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005358}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005359
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005360component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005361 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005362 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005363 # Build for a target platform that's close to what Debian uses
5364 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005365 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005366 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005367 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005368 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'
5369
Gilles Peskinee36fe812021-09-01 20:00:33 +02005370 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005371 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005372 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005373 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005374}
5375support_build_arm_linux_gnueabi_gcc_arm5vte () {
5376 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5377}
5378
5379component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005380 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005381 scripts/config.py baremetal
5382 # This is an imperfect substitute for
5383 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005384 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005385 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 +02005386
Gilles Peskinee36fe812021-09-01 20:00:33 +02005387 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005388 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005389 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005390 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005391}
5392
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005393component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005394 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5395 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005396 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 +02005397
Gilles Peskinee36fe812021-09-01 20:00:33 +02005398 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005399 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005400 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005401 ${ARM_NONE_EABI_GCC_PREFIX}size -t ${BUILTIN_SRC_PATH}/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005402 for lib in library/*.a; do
5403 echo "$lib:"
5404 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5405 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005406}
5407
Gilles Peskine8f073122018-11-27 15:58:47 +01005408component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005409 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005410 scripts/config.py baremetal
5411 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005412 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 +01005413 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005414 not grep __aeabi_uldiv library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005415 not grep __aeabi_uldiv ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005416 not grep __aeabi_uldiv ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005417}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005418
Gilles Peskine8f073122018-11-27 15:58:47 +01005419component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005420 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005421 scripts/config.py baremetal
5422 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005423 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 +01005424 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005425 not grep __aeabi_lmul library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005426 not grep __aeabi_lmul ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005427 not grep __aeabi_lmul ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005428}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005429
Dave Rodgman8c315f22023-06-02 10:26:24 -04005430component_build_arm_clang_thumb () {
5431 # ~ 30s
5432
5433 scripts/config.py baremetal
5434
5435 msg "build: clang thumb 2, make"
5436 make clean
5437 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5438
5439 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5440 msg "build: clang thumb 1 -O0, make"
5441 make clean
5442 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5443
5444 msg "build: clang thumb 1 -Os, make"
5445 make clean
5446 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5447}
5448
Gilles Peskine8f073122018-11-27 15:58:47 +01005449component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005450 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005451 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005452 # armc[56] don't support SHA-512 intrinsics
5453 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005454
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005455 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5456 scripts/config.py unset MBEDTLS_AESCE_C
5457
Dave Rodgman0fddf822023-03-02 15:32:12 +00005458 # Stop armclang warning about feature detection for A64_CRYPTO.
5459 # With this enabled, the library does build correctly under armclang,
5460 # but in baremetal builds (as tested here), feature detection is
5461 # unavailable, and the user is notified via a #warning. So enabling
5462 # this feature would prevent us from building with -Werror on
5463 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005464 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005465
Hanno Beckerf0762e92022-07-15 12:08:19 +01005466 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005467
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005468 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005469
5470 msg "size: ARM Compiler 5"
5471 "$ARMC5_FROMELF" -z library/*.o
Ronald Cron5b41a652024-07-03 08:59:47 +02005472 "$ARMC5_FROMELF" -z ${PSA_CORE_PATH}/*.o
Ronald Cron709bbf02024-07-03 07:59:30 +02005473 "$ARMC5_FROMELF" -z ${BUILTIN_SRC_PATH}/*.o
Gilles Peskine18487f62020-04-30 23:11:54 +02005474
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005475 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005476
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005477 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005478 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005479
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005480 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005481 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5482
5483 # ARM Compiler 6 - Target ARMv7-M+DSP
5484 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005485
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005486 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005487 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005488
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005489 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005490 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005491
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005492 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5493 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5494
Dave Rodgman99318e62023-05-24 12:27:42 +01005495 # ARM Compiler 6 - Target Cortex-M0
5496 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005497
5498 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5499 #
5500 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5501 # that we have in our CI
5502 scripts/config.py set MBEDTLS_AESCE_C
5503 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005504}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005505
Pengyu Lvdf070032023-02-24 16:03:31 +08005506support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005507 armc5_cc="$ARMC5_BIN_DIR/armcc"
5508 armc6_cc="$ARMC6_BIN_DIR/armclang"
5509 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005510}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005511
Ronald Crond2cb7f42024-03-18 12:49:18 +01005512component_test_tls12_only () {
5513 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5514 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5515 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5516 make
5517
5518 msg "test: main suites (inc. selftests) (ASan build)"
5519 make test
5520
5521 msg "test: ssl-opt.sh (ASan build)"
5522 tests/ssl-opt.sh
5523
5524 msg "test: compat.sh (ASan build)"
5525 tests/compat.sh
5526}
5527
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005528component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005529 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005530 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005531 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005532 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5533
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005534 msg "test: TLS 1.3 only, all key exchange modes enabled"
5535 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005536
Ronald Cronc3f43b62022-10-17 17:35:32 +02005537 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5538 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005539}
5540
Ronald Cronc3f43b62022-10-17 17:35:32 +02005541component_test_tls13_only_psk () {
5542 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5543 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5544 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5545 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005546 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005547 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5548 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5549 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5550 scripts/config.py unset MBEDTLS_ECDSA_C
5551 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005552 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005553 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005554 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5555
Ronald Cronc3f43b62022-10-17 17:35:32 +02005556 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5557 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005558
Ronald Cronc3f43b62022-10-17 17:35:32 +02005559 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5560 tests/ssl-opt.sh
5561}
5562
5563component_test_tls13_only_ephemeral () {
5564 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5565 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5566 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005567 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005568 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5569
5570 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5571 cd tests; ./test_suite_ssl; cd ..
5572
5573 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5574 tests/ssl-opt.sh
5575}
5576
Przemek Stekiela01c2422023-06-13 10:46:48 +02005577component_test_tls13_only_ephemeral_ffdh () {
5578 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5579 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5580 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5581 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005582 scripts/config.py unset MBEDTLS_ECDH_C
5583
Przemek Stekiela01c2422023-06-13 10:46:48 +02005584 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5585
5586 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5587 cd tests; ./test_suite_ssl; cd ..
5588
5589 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5590 tests/ssl-opt.sh
5591}
5592
Ronald Cronc3f43b62022-10-17 17:35:32 +02005593component_test_tls13_only_psk_ephemeral () {
5594 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5595 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5596 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5597 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5598 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5599 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5600 scripts/config.py unset MBEDTLS_ECDSA_C
5601 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005602 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005603 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005604 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5605
5606 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5607 cd tests; ./test_suite_ssl; cd ..
5608
5609 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5610 tests/ssl-opt.sh
5611}
5612
Przemek Stekiela01c2422023-06-13 10:46:48 +02005613component_test_tls13_only_psk_ephemeral_ffdh () {
5614 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5615 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5616 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5617 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5618 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5619 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5620 scripts/config.py unset MBEDTLS_ECDSA_C
5621 scripts/config.py unset MBEDTLS_PKCS1_V21
5622 scripts/config.py unset MBEDTLS_PKCS7_C
5623 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005624 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005625 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5626
5627 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5628 cd tests; ./test_suite_ssl; cd ..
5629
5630 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5631 tests/ssl-opt.sh
5632}
5633
Ronald Cronc3f43b62022-10-17 17:35:32 +02005634component_test_tls13_only_psk_all () {
5635 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5636 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5637 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5638 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5639 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5640 scripts/config.py unset MBEDTLS_ECDSA_C
5641 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005642 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005643 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005644 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5645
5646 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5647 cd tests; ./test_suite_ssl; cd ..
5648
5649 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5650 tests/ssl-opt.sh
5651}
5652
5653component_test_tls13_only_ephemeral_all () {
5654 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5655 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005656 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005657 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5658
5659 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5660 cd tests; ./test_suite_ssl; cd ..
5661
5662 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5663 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005664}
5665
Ronald Cron46ac0652024-03-18 12:39:04 +01005666component_test_tls13_no_padding () {
5667 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005668 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005669 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005670 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005671 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005672 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005673 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005674 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005675 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005676}
5677
Ronald Cron6f135e12021-12-08 16:57:54 +01005678component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005679 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005680 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005681 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005682 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005683 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005684 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005685 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005686 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005687 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005688}
5689
Ronald Crondd96c0a2024-04-02 12:34:24 +02005690component_test_full_minus_session_tickets() {
5691 msg "build: full config without session tickets"
5692 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005693 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005694 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005695 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5696 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005697 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005698 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005699 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005700 tests/ssl-opt.sh
5701}
5702
Gilles Peskine8f073122018-11-27 15:58:47 +01005703component_build_mingw () {
5704 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005705 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 +00005706
Gilles Peskine8f073122018-11-27 15:58:47 +01005707 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005708 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 +01005709 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005710
Gilles Peskine8f073122018-11-27 15:58:47 +01005711 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005712 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
5713 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 +01005714 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005715
Pengyu Lv158eead2023-10-19 11:27:05 +08005716 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005717 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005718 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 +01005719 make WINDOWS_BUILD=1 clean
5720}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005721support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005722 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5723 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005724 *) true;;
5725 esac
5726}
Simon Butcher91aef332016-11-17 09:20:50 +00005727
Gilles Peskine8f073122018-11-27 15:58:47 +01005728component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005729 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005730 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005731 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5732 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005733
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005734 msg "test: main suites (MSan)" # ~ 10s
5735 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005736
Gilles Peskine6848d172023-11-02 19:58:03 +01005737 msg "test: metatests (MSan)"
5738 tests/scripts/run-metatests.sh any msan
5739
Gilles Peskine82b27272019-06-14 18:27:03 +02005740 msg "program demos (MSan)" # ~20s
5741 tests/scripts/run_demos.py
5742
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005743 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005744 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005745
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005746 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005747
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005748 if [ "$MEMORY" -gt 0 ]; then
5749 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005750 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005751 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005752}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005753
Bence Szépkúti0354d042023-12-06 16:14:37 +01005754component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005755 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005756 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005757 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5758 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005759
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005760 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005761 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005762
Gilles Peskine636c26a2020-03-04 20:46:15 +01005763 # Optional parts (slow; currently broken on OS X because programs don't
5764 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005765 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005766 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005767 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005768 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005769 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005770
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005771 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005772 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005773 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005774 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005775
5776 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005777 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005778 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005779 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005780}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005781
Bence Szépkúti0354d042023-12-06 16:14:37 +01005782component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005783 msg "build: Release, full (clang)"
5784 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5785 scripts/config.py full
5786 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5787 make
5788
5789 msg "test: main suites, Valgrind (full config)"
5790 make memcheck
5791}
5792
Paul Elliott62dc3922021-11-25 17:29:40 +00005793support_test_cmake_out_of_source () {
5794 distrib_id=""
5795 distrib_ver=""
5796 distrib_ver_minor=""
5797 distrib_ver_major=""
5798
5799 # Attempt to parse lsb-release to find out distribution and version. If not
5800 # found this should fail safe (test is supported).
5801 if [[ -f /etc/lsb-release ]]; then
5802
5803 while read -r lsb_line; do
5804 case "$lsb_line" in
5805 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5806 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5807 esac
5808 done < /etc/lsb-release
5809
5810 distrib_ver_major="${distrib_ver%%.*}"
5811 distrib_ver="${distrib_ver#*.}"
5812 distrib_ver_minor="${distrib_ver%%.*}"
5813 fi
5814
5815 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5816 # processor (as the CI does) can create a race condition whereby the build
5817 # fails to see a generated file, despite that file actually having been
5818 # generated. This problem appears to go away with 18.04 or newer, so make
5819 # the out of source tests unsupported on Ubuntu 16.04.
5820 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5821}
5822
Gilles Peskine8f073122018-11-27 15:58:47 +01005823component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005824 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005825 # generates
5826 make neat
5827
Gilles Peskine8f073122018-11-27 15:58:47 +01005828 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005829 MBEDTLS_ROOT_DIR="$PWD"
5830 mkdir "$OUT_OF_SOURCE_DIR"
5831 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005832 # Note: Explicitly generate files as these are turned off in releases
5833 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005834 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005835
Gilles Peskine8f073122018-11-27 15:58:47 +01005836 msg "test: cmake 'out-of-source' build"
5837 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005838 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005839 # Also ensure that there are no error messages such as
5840 # "No such file or directory", which would indicate that some required
5841 # file is missing (ssl-opt.sh tolerates the absence of some files so
5842 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005843 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005844 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005845 cat ssl-opt.err >&2
5846 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005847 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005848 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005849 cd "$MBEDTLS_ROOT_DIR"
5850 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005851}
Andres AGdc192212016-08-31 17:33:13 +01005852
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005853component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005854 # Remove existing generated files so that we use the ones CMake
5855 # generates
5856 make neat
5857
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005858 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005859 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005860 # Note: Explicitly generate files as these are turned off in releases
5861 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005862 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005863 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005864}
Gilles Peskinea3000992022-02-04 00:21:12 +01005865support_test_cmake_as_subdirectory () {
5866 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005867}
5868
Chris Kayd259e342021-03-25 16:03:25 +00005869component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005870 # Remove existing generated files so that we use the ones CMake
5871 # generates
5872 make neat
5873
Chris Kayd259e342021-03-25 16:03:25 +00005874 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005875 cd programs/test/cmake_package
5876 cmake .
5877 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005878 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005879}
Gilles Peskinea3000992022-02-04 00:21:12 +01005880support_test_cmake_as_package () {
5881 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005882}
5883
5884component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005885 # Remove existing generated files so that we use the ones CMake
5886 # generates
5887 make neat
5888
Chris Kayd259e342021-03-25 16:03:25 +00005889 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005890 cd programs/test/cmake_package_install
5891 cmake .
5892 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005893 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005894}
Gilles Peskinea3000992022-02-04 00:21:12 +01005895support_test_cmake_as_package_install () {
5896 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005897}
5898
David Horstmann20550e32023-01-12 14:17:01 +00005899component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005900 # Make a copy of config file to use for the in-tree test
5901 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005902
5903 MBEDTLS_ROOT_DIR="$PWD"
5904 mkdir "$OUT_OF_SOURCE_DIR"
5905 cd "$OUT_OF_SOURCE_DIR"
5906
David Horstmann969c1452023-01-31 10:34:44 +00005907 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005908 cmake "$MBEDTLS_ROOT_DIR"
5909 make
5910
5911 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5912 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005913 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005914 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5915 make
5916
5917 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5918 # In the user config, disable one feature (for simplicity, pick a feature
5919 # that nothing else depends on).
5920 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5921
5922 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5923 make
5924 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5925
5926 rm -f user_config.h full_config.h
5927
5928 cd "$MBEDTLS_ROOT_DIR"
5929 rm -rf "$OUT_OF_SOURCE_DIR"
5930
5931 # Now repeat the test for an in-tree build:
5932
David Horstmann969c1452023-01-31 10:34:44 +00005933 # Restore config for the in-tree test
5934 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005935
David Horstmann969c1452023-01-31 10:34:44 +00005936 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005937 cmake .
5938 make
5939
5940 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5941 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005942 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005943 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5944 make
5945
5946 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5947 # In the user config, disable one feature (for simplicity, pick a feature
5948 # that nothing else depends on).
5949 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5950
5951 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5952 make
5953 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5954
5955 rm -f user_config.h full_config.h
5956}
5957support_build_cmake_custom_config_file () {
5958 support_test_cmake_out_of_source
5959}
5960
David Horstmann041ed422024-05-10 14:37:48 +01005961component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01005962 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01005963 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
5964 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
5965 make
5966}
5967support_build_cmake_programs_no_testing () {
5968 support_test_cmake_out_of_source
5969}
David Horstmann20550e32023-01-12 14:17:01 +00005970
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005971component_build_zeroize_checks () {
5972 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5973
5974 scripts/config.py full
5975
5976 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00005977 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 +01005978}
5979
5980
Gilles Peskine8f073122018-11-27 15:58:47 +01005981component_test_zeroize () {
5982 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5983 # different combinations of compilers and optimization flags by using an
5984 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5985 # system in all cases that the script fails, so we must manually search the
5986 # output to check whether the pass string is present and no failure strings
5987 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005988
Gilles Peskine4976e822019-01-06 19:52:22 +00005989 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5990 # about a spurious message if Gdb tries and fails, so suppress that.
5991 gdb_disable_aslr=
5992 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
5993 gdb_disable_aslr='set disable-randomization off'
5994 fi
5995
Gilles Peskine8f073122018-11-27 15:58:47 +01005996 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01005997 for compiler in clang gcc; do
5998 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
5999 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006000 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6001 grep "The buffer was correctly zeroized" test_zeroize.log
6002 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006003 rm -f test_zeroize.log
6004 make clean
6005 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006006 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006007}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006008
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006009component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006010 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006011 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006012 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006013
6014 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006015 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006016}
6017
6018support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006019 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006020 ver="$(cmake --version)"
6021 ver="${ver#cmake version }"
6022 ver_major="${ver%%.*}"
6023
6024 ver="${ver#*.}"
6025 ver_minor="${ver%%.*}"
6026
6027 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006028}
6029
Gilles Peskinec848d222022-12-09 12:23:35 +01006030component_check_code_style () {
6031 msg "Check C code style"
6032 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006033}
6034
Gilles Peskinec848d222022-12-09 12:23:35 +01006035support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006036 case $(uncrustify --version) in
6037 *0.75.1*) true;;
6038 *) false;;
6039 esac
6040}
6041
Gilles Peskine8f073122018-11-27 15:58:47 +01006042component_check_python_files () {
6043 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006044 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006045}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006046
Joe Subbianid614c0b2021-07-29 11:18:29 +01006047component_check_test_helpers () {
6048 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006049 # unittest writes out mundane stuff like number or tests run on stderr.
6050 # Our convention is to reserve stderr for actual errors, and write
6051 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006052 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006053
Joe Subbiania25ffab2021-08-06 09:41:27 +01006054 msg "unit test: translate_ciphers.py"
6055 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006056}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006057
Valerio Settid9e42512024-05-06 15:59:51 +02006058component_test_psasim() {
Valerio Setti9022f712024-06-27 07:59:39 +02006059 msg "build server library and application"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006060 scripts/config.py crypto
Valerio Settid8b59372024-07-02 12:02:25 +02006061 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006062 helper_psasim_build server
Valerio Settid1b6ef12024-05-07 16:00:21 +02006063
Valerio Settid8b59372024-07-02 12:02:25 +02006064 helper_psasim_cleanup_before_client
Valerio Settif98635c2024-06-10 20:13:13 +02006065
6066 msg "build library for client"
Valerio Settid8b59372024-07-02 12:02:25 +02006067 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006068 helper_psasim_build client
Valerio Settif98635c2024-06-10 20:13:13 +02006069
Valerio Setti5beb2362024-06-24 13:13:17 +02006070 msg "build basic psasim client"
6071 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_base
6072 msg "test basic psasim client"
6073 tests/psa-client-server/psasim/test/run_test.sh psa_client_base
Valerio Settid9e42512024-05-06 15:59:51 +02006074
Valerio Setti5beb2362024-06-24 13:13:17 +02006075 msg "build full psasim client"
6076 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client_full
6077 msg "test full psasim client"
6078 tests/psa-client-server/psasim/test/run_test.sh psa_client_full
Valerio Settid9e42512024-05-06 15:59:51 +02006079
Valerio Settid9e42512024-05-06 15:59:51 +02006080 make -C tests/psa-client-server/psasim clean
6081}
Jerry Yud767cc42023-03-31 15:03:55 +08006082
Valerio Setti9022f712024-06-27 07:59:39 +02006083component_test_suite_with_psasim()
6084{
6085 msg "build server library and application"
Valerio Settid8b59372024-07-02 12:02:25 +02006086 helper_psasim_config server
Valerio Setti9022f712024-06-27 07:59:39 +02006087 # Modify server's library configuration here (if needed)
6088 helper_psasim_build server
6089
Valerio Settid8b59372024-07-02 12:02:25 +02006090 helper_psasim_cleanup_before_client
Valerio Setti9022f712024-06-27 07:59:39 +02006091
6092 msg "build client library"
Valerio Settid8b59372024-07-02 12:02:25 +02006093 helper_psasim_config client
Valerio Setti9022f712024-06-27 07:59:39 +02006094 # PAKE functions are still unsupported from PSASIM
6095 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
6096 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
6097 helper_psasim_build client
6098
6099 msg "build test suites"
6100 make PSASIM=1 CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" tests
6101
6102 helper_psasim_server start
6103
Valerio Setti1a493832024-07-01 07:29:02 +02006104 # psasim takes an extremely long execution time on some test suites so we
6105 # exclude them from the list.
6106 SKIP_TEST_SUITES="constant_time_hmac,lmots,lms"
6107 export SKIP_TEST_SUITES
6108
Valerio Setti9022f712024-06-27 07:59:39 +02006109 msg "run test suites"
6110 make PSASIM=1 test
6111
6112 helper_psasim_server kill
6113}
6114
Gilles Peskine192c72f2017-12-21 15:59:21 +01006115################################################################
6116#### Termination
6117################################################################
6118
Gilles Peskine8f073122018-11-27 15:58:47 +01006119post_report () {
6120 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006121 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006122
Gilles Peskine8f073122018-11-27 15:58:47 +01006123 final_report
6124}
6125
6126
6127
6128################################################################
6129#### Run all the things
6130################################################################
6131
Gilles Peskine5d996822020-03-28 21:09:21 +01006132# Function invoked by --error-test to test error reporting.
6133pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006134 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006135 if [ $KEEP_GOING -ne 0 ]; then
6136 echo "Expect three failing commands."
6137 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006138 # If the component doesn't run in a subshell, changing error_test_i to an
6139 # invalid integer will cause an error in the loop that runs this function.
6140 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006141 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006142 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006143 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006144 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006145 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006146 make unknown_target
6147 false "this should not be executed"
6148}
6149
Gilles Peskinee48351a2018-11-27 16:06:30 +01006150# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006151run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006152 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006153 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006154
6155 # Unconditionally create a seedfile that's sufficiently long.
6156 # Do this before each component, because a previous component may
6157 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006158 local dd_cmd
6159 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6160 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006161 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006162 esac
6163 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006164
Ronald Cron635a2be2024-07-12 14:30:16 +02006165 if [ -d tf-psa-crypto ]; then
6166 dd_cmd=(dd if=/dev/urandom of=./tf-psa-crypto/tests/seedfile bs=64 count=1)
6167 case $OSTYPE in
6168 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
6169 esac
6170 "${dd_cmd[@]}"
6171 fi
6172
Gilles Peskineec135542021-08-02 23:14:03 +02006173 # Run the component in a subshell, with error trapping and output
6174 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006175 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006176 # We want to keep running if the subshell fails, so 'set -e' must
6177 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006178 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006179 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006180 (
6181 if [ $QUIET -eq 1 ]; then
6182 # msg() will be silenced, so just print the component name here.
6183 echo "${current_component#component_}"
6184 exec >/dev/null
6185 fi
6186 if [ $KEEP_GOING -eq 1 ]; then
6187 # Keep "set -e" off, and run an ERR trap instead to record failures.
6188 set -E
6189 trap err_trap ERR
6190 fi
6191 # The next line is what runs the component
6192 "$@"
6193 if [ $KEEP_GOING -eq 1 ]; then
6194 trap - ERR
6195 exit $last_failure_status
6196 fi
6197 )
6198 component_status=$?
6199 if [ $KEEP_GOING -eq 1 ]; then
6200 set -e
6201 if [ $component_status -ne 0 ]; then
6202 failure_count=$((failure_count + 1))
6203 fi
6204 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006205
6206 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006207 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006208 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006209}
6210
6211# Preliminary setup
6212pre_check_environment
6213pre_initialize_variables
6214pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006215
Dave Rodgman21900632024-02-26 11:41:19 +00006216setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006217pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006218pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006219pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006220
Gilles Peskine878cf602019-01-06 20:50:38 +00006221build_status=0
6222if [ $KEEP_GOING -eq 1 ]; then
6223 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006224fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006225pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006226pre_print_configuration
6227pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006228cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006229if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006230 pre_generate_files
6231fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006232
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006233# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006234for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006235 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006236done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006237unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006238for component in $RUN_COMPONENTS; do
6239 run_component "component_$component"
6240done
Gilles Peskine8f073122018-11-27 15:58:47 +01006241
6242# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006243post_report